docs-project

Solid

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', 'инженерная документация'.

AI & Automation 5 stars 0 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
26
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# 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 | File | Purpose | Phase | Template | |------|---------|:-----:|----------| | `README.md` | Overview: what it is, stack, status, quick start, structure | 1 → 10 | `templates/project/README.tmpl` | | `ENTRY.md` | Entry point: "start here", navigation "topic → file", onboarding checklist | 9 | `templates/project/ENTRY.tmpl` | | `AGENT.md` | Runbook for the autonomous build agent: phases, rules, DoD, commit gate | 8 | — | | `DELIVERY.md` | Delivery gate: build/run/verify, what's in, what's NOT | 8 | — | | Legal/community | LICENSE, CONTRIBUTING, CODE_OF_CONDUCT, SECURITY | 1/9 | — | ## docs/ — engineering documents | File | Purpose | Phase | Template | |------|---------|:-----:|----------| | `docs/REFERENCE.md`...

Details

Author
bestdeejay-design
Repository
bestdeejay-design/agent-skills
Created
1 weeks ago
Last Updated
yesterday
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Solid

docs-product

Product documentation branch — the 'why' and 'what' of a project: VISION.md, PRD.md, ROADMAP.md, FEATURES.md. Written from an idea forward, before engineering docs. Order: VISION -> PRD -> ROADMAP -> FEATURES. Full catalog + checklist in references/product-docs.md, templates in templates/. Triggers: 'продуктовая документация', 'vision', 'prd', 'роадмап', 'roadmap', 'фичи документация', 'product docs', 'требования к продукту', 'документация продукта'.

5 Updated yesterday
bestdeejay-design
AI & Automation Solid

docs-system

Meta-guide + router for documentation: the two branches (docs-product for 'why/what', docs-project for 'how'), the phase order, completeness levels L1/L2/L3, and the completeness checklist. Load a branch directly when the task is clearly product or engineering; load this skill for the big picture, ordering and completeness gates. Triggers: 'документация', 'набор документации', 'каталог документов', 'документация структура', 'полная документация', 'docs catalog', 'documentation structure', 'какую документацию писать'.

5 Updated yesterday
bestdeejay-design
AI & Automation Listed

engineering-docs

Use for creating, placing, indexing, updating, or archiving engineering docs and docs structures. Not for prose-only rewriting or session continuity; use engineering-writing or session.

1 Updated 4 days ago
mblauberg