agentleFS
ZeeshanSultanZeeshanSultan/DocGov/skills/brief/SKILL.md

brief

Skill0 starsChanged 2 months agoMITView on GitHub

Load the minimal authoritative documentation context for a topic or domain before changing code — the constitution, the canonical specification, the invariants in force, the relevant ADRs and the machine contracts, and nothing else. Use before implementing or modifying anything in a governed area.

78 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use capture, strategy and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • toneron2Skill

    capture

    Capture thoughts to inbox with automatic classification

    Also in 6 projects that use this

  • EpistatesSkill

    strategy

    Plan weekly or monthly X content strategy. Use when the user wants to plan their content calendar, set growth goals, build a content pipeline, or think strategically about their X presence.

    Also in 4 projects that use this

  • aleksander-dytkoSkill

    decision

    Make a product decision with full context from the vault and available sources

    Also in 3 projects that use this

  • dirienSkill

    decide

    Three-agent adversarial debate protocol for strategic decisions. Two advocates steelman opposing positions while a moderator identifies risks and synthesizes a binding consensus. Use when choosing between alternatives, evaluating tradeoffs, or making high-stakes decisions.

    Also in 5 projects that use this

  • JaimeGBASkill

    ingest

    Digest an external source (article, paper, transcript, URL, book chapter) and integrate its content into the knowledge base

    Also in 7 projects that use this

  • howellsSkill

    reconcile

    Audit a project against current plugin conventions and offer to update structure.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

5 rules. 0 are common, 3 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 71 edited versions we read keep these.

  • 3

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Invariants are binding: If one blocks your approach, the invariant wins.

    line 26
  2. Distinctive:

    Lower authority may not contradict higher: If you find the canonical specification and a guide disagreeing, the canonical specification is …

    line 33
  3. Distinctive:

    If the pack is wrong, fix the document: Do not write code that works around incorrect documentation and leave the documentation incorrect — …

    line 36
  4. Very specific:

    If the pack looks too thin or too wide, docgov brief <topic> --explain says what happened to every document it considered.

    line 47
  5. Very specific:

    After you change code here, run /docgov:affected to find out which of these documents you now owe an update.

    line 50

“Common” is measured: kept by at least 6 in 10 of the 71 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Authoritative context

!docgov brief $ARGUMENTS 2>&1 | head -c 28000

How to use this

Everything above is authoritative and ordered: the most authoritative document is first. It replaces reading the documentation tree — that is the point, and it is why the pack is small.

Read the map first. The six lines at the top say what governs this area, what you may not violate, which code is claimed, what is derived from what, what is already known to be stale, and where two documents play the same role. Nothing in it is an opinion; every entry points at a document below. KNOWN STALE unknown means it could not be checked, not that nothing is stale.

The rules while you work in this area:

  1. Invariants are binding. If one blocks your approach, the invariant wins. Changing it means changing its source document in the same change, with a stated reason. Do not route around it.
  2. Machine contracts beat prose. Where a schema, OpenAPI document or migration is listed, it is authoritative over any description of it, including the one in this pack.
  3. Lower authority may not contradict higher. If you find the canonical specification and a guide disagreeing, the canonical specification is right and the guide is a bug.
  4. If the pack is wrong, fix the document. Do not write code that works around incorrect documentation and leave the documentation incorrect — that is exactly the state this product exists to prevent.
  5. "Not included in full" entries are real documents that did not fit the budget. Read them directly if your change touches what their headings describe.
  6. A document listed under KNOWN STALE is a warning, not a lie. It describes code that has moved since it was last touched. Trust it about intent; verify it against the code before trusting it about behaviour, and update it as part of your change.

If the pack looks too thin or too wide, docgov brief <topic> --explain says what happened to every document it considered. Do not guess at it.

After you change code here, run /docgov:affected to find out which of these documents you now owe an update.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.