awesome-docs
Installation
SKILL.md
Awesome Docs
This skill treats project documentation as an interface between human understanding and automated AI execution. The goal is not to produce verbose reports; the goal is to preserve project state in a form that a human can read quickly and a future AI agent can act on without guessing.
Core Contract
When the user asks to record project knowledge:
- Resolve the documentation root.
- Classify the content.
- Create or update the right document.
- Write in a concise, factual, readable style with a clear story line.
- Re-read the full document after writing and run the post-write checklist for readability, consistent structure, complete required modules, evidence, conclusions, and next steps.
- Unless the user opts out, run the separate plain-language pass after the content review, following references/post-write-polish.md.
- If the request is about reusable commands, update
常用命令.txtwith single-line commands and skip prose polishing for command lines.
Documentation Root
Use the user-specified documentation path if provided.