docs-system

Solid

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', 'какую документацию писать'.

AI & Automation 5 stars 0 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 81/100

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

Skill Content

# Docs System — meta-guide & router > **This skill is now the meta-guide.** The two branches live in focused skills: > load them directly. Use this skill for the big picture: which docs to write, > in which order, and how complete the set must be. ## Two branches of documentation | Branch | Answers | Skill | |---|---|---| | **Product docs** — «why» and «what» | VISION → PRD → ROADMAP → FEATURES | `docs-product` | | **Project docs** — «how» | README/ENTRY/ARCHITECTURE/ADR/contracts/tests + REFERENCE map | `docs-project` | Rule: product docs answer «why» and «what»; engineering docs answer «how». If a doc has no reader and no question it answers — it does not belong. ## When to use this skill (router) - The task is about the documentation SYSTEM as a whole: what to write, in what order, how complete. - The phases / levels / completeness gates need to be applied. - The task is clearly product OR engineering → load the branch directly instead. ## Order and levels - **Phase order** (when to write each doc): `references/order.md`. - **Levels L1/L2/L3** (how deep a doc set must be for the system size): `references/levels.md`. - **Completeness checklist** (what a complete doc set looks like): `references/completeness.md`. ## Golden rules - Nothing is written "from the end": VISION → PRD → ROADMAP → FEATURES, then engineering docs. - Contracts (OpenAPI/AsyncAPI) are written BEFORE code. - The map (`REFERENCE.md`) is written last — it describes everything above it. - ...

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-project

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

5 Updated yesterday
bestdeejay-design
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 Listed

doc-routing

Documentation Router & Architect — decides WHERE new information belongs in the project documentation system. Use BEFORE creating/updating any docs: PRD, features, journeys, integrations, NFR, requirements. Guarantees consistency and prevents duplication. Triggers: "doc routing", "document this", "where to put docs", "doc architecture", «куда писать», «документация», "/doc-routing"

0 Updated 3 weeks ago
akuroglo