agentleFS
Sign inStart free
bestdeejay-designbestdeejay-design/agent-skills/skills/docs-project/SKILL.md

docs-project

Skill6 starsChanged 3 months agoMITView on GitHub

Project (engineering) documentation branch — the 'how': README, ENTRY, AGENT/DELIVERY runbooks, and docs/ (REFERENCE map, ARCHITECTURE, ADR, SAGA, TEST_CASES, DEV_GUIDE, IMPROVEMENTS, TROUBLESHOOTING, BACKLOG, REVIEW, STATUS) plus contracts/ (OpenAPI/AsyncAPI — machine truth written BEFORE code). The map rule: every doc gets a card in REFERENCE.md. Full catalog + checklist in references/project-docs.md. Triggers: 'проектная документация', 'архитектура документация', 'adr', 'engineering docs', 'документация разработчика', 'контракты openapi', 'project docs', 'инженерная документация'.

The file

We split this skill into the rules it gives an agent

7 rules. About 0 are common, 3 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use this skill to write the engineering documents: architecture, decisions (ADR), contracts, dev guides, tests, and the documentation map.

    line 14
  2. Very specific:

    Every document that exists gets a card in docs/REFERENCE.md (purpose → structure → key facts → links).

    line 69
  3. Very specific:

    Do not use for product vision, PRDs, or roadmap decisions.

    line 87
  4. Distinctive:

    Write contracts before implementation docs when the project exposes APIs or events.

    line 92
  5. Distinctive:

    Add runbooks and test cases with copy-pasteable commands and expected results.

    line 94
  6. Very specific:

    Write REFERENCE.md last and add a card for every document.

    line 95
  7. Distinctive:

    Every generated document names its source of truth, owner or update trigger, prerequisites, commands, and failure path.

    line 99

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “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

Docs Project — engineering documentation («how»)

Use this skill to write the engineering documents: architecture, decisions (ADR), contracts, dev guides, tests, and the documentation map. Assumes the product docs exist (docs-product: VISION/PRD/ROADMAP/FEATURES).

When to use

  • A project needs its engineering docs: README, ENTRY, ARCHITECTURE, ADR, tests.
  • User asks for "проектная документация", "архитектура документация", "adr", "инженерная документация", "контракты openapi", "engineering docs".
  • Contracts (OpenAPI/AsyncAPI) must be written before code.

Do NOT use

  • For product docs (VISION/PRD/ROADMAP/FEATURES) — that is docs-product.
  • For the meta-guide (phases, levels L1/L2/L3, completeness checklist) — docs-system.

Root documents

FilePurposePhaseTemplate
README.mdOverview: what it is, stack, status, quick start, structure1 → 10templates/project/README.tmpl
ENTRY.mdEntry point: "start here", navigation "topic → file", onboarding checklist9templates/project/ENTRY.tmpl
AGENT.mdRunbook for the autonomous build agent: phases, rules, DoD, commit gate8—
DELIVERY.mdDelivery gate: build/run/verify, what's in, what's NOT8—
Legal/communityLICENSE, CONTRIBUTING, CODE_OF_CONDUCT, SECURITY1/9—

docs/ — engineering documents

FilePurposePhaseTemplate
docs/REFERENCE.mdThe map. Card for EVERY doc: purpose/structure/facts/links, hierarchy of truth, drift table. Written last.10templates/project/REFERENCE.tmpl
docs/ARCHITECTURE.mdComponents, communication, data flows, tech stack2 → 6templates/project/ARCHITECTURE.tmpl
docs/ADR/ADR-000.mdArchitecture Decision Records — one per significant decision2 (ongoing)templates/project/ADR-000.tmpl
docs/SAGA.mdCross-module scenarios (choreography, events, compensation, idempotency)5templates/project/SAGA.tmpl
docs/TEST_CASES.mdTest cases (Gherkin-style) + coverage matrix6templates/project/TEST_CASES.tmpl
docs/DEV_GUIDE.mdLocal dev: prerequisites, run, env, migrations, debugging7templates/project/DEV_GUIDE.tmpl
docs/IMPROVEMENTS.mdKnown issues / doc-vs-fact drift + prioritized fix plan8templates/project/IMPROVEMENTS.tmpl
docs/TROUBLESHOOTING.mdRuntime error diagnostics (E1…En) + startup checklist8templates/project/TROUBLESHOOTING.tmpl
docs/BACKLOG.mdIdeas, deferred features, priorities1templates/project/BACKLOG.tmpl
docs/REVIEW.mdDoc audit: problems, resolutions, per-service status10templates/project/REVIEW.tmpl
docs/STATUS.mdL1 alternative to REVIEW: done / in progress / limitations10templates/project/STATUS.tmpl

contracts/ — machine truth (API-first / microservices)

PathPurposeWhen
contracts/openapi/*.yamlPer-service OpenAPI specs — the HTTP truthbefore code
contracts/asyncapi/events.yamlEvent catalog — the event truthbefore code
contracts/test/Contract-conformance test fixtureswith tests

Contracts are written BEFORE code. The code implements the contract, not the other way around — «machine truth before code».

The map rule

Every document that exists gets a card in docs/REFERENCE.md (purpose → structure → key facts → links). Written last, maintained on every change: touch a doc → update its card.

Checklist (project side)

  • One entry point exists (ENTRY.md) and routes "topic → file".
  • Every doc has a card in REFERENCE.md (including REFERENCE itself).
  • Hierarchy of truth declared (which doc wins on conflict).
  • Drift table (doc-vs-fact) populated — no silent inconsistencies.
  • Contracts exist before code for every API/event (API-first projects).
  • DELIVERY.md states how to build/verify/what's in/what's NOT.

Rule: engineering docs answer «how»; the map (REFERENCE.md) is written last because it describes everything above it.

Boundaries

  • Do not use for product vision, PRDs, or roadmap decisions; use docs-product.

Authoring procedure

  1. Inventory the repository and establish the hierarchy of truth.
  2. Write contracts before implementation docs when the project exposes APIs or events.
  3. Draft architecture and ADRs from observed code and explicit decisions; label assumptions.
  4. Add runbooks and test cases with copy-pasteable commands and expected results.
  5. Write REFERENCE.md last and add a card for every document.

Definition of done

Every generated document names its source of truth, owner or update trigger, prerequisites, commands, and failure path. Verify links, commands, and contract examples against the repository; do not mark a document complete merely because the template is filled.

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.

Check your setup, free