Menu
Create or update project documentation (README.md and /docs). Use this when asked to write, update or improve documentation.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
| name | awa-documentation |
| description | Create or update project documentation (README.md and /docs). Use this when asked to write, update or improve documentation. |
${input}
You MUST consider the user input before proceeding (if not empty).
Update or create documentation as specified in the instruction above, following awa conventions.
README.md # Project entry point (user-facing)
docs/
├── {topic}.md # Documentation on a specific topic
├── getting-started.md # Quick start guide
├── configuration.md # Configuration reference
├── cli-reference.md # CLI command reference (if CLI project)
├── api.md # API reference (if library)
├── templates.md # Template authoring (if template-based)
├── architecture.md # Public architecture overview (optional)
└── contributing.md # Contribution guidelines (or CONTRIBUTING.md at root)
README.md is the entry point
/docs contains detailed documentation
Derive from specifications
Keep synchronized
You SHALL write documentation for end users, not internal developers. You SHALL keep README.md concise and link to /docs for details. You SHALL derive documentation content from architecture and design specs. You SHALL NOT duplicate specification content; summarize and reference. You SHALL ensure code examples are accurate and runnable. You SHALL use consistent terminology matching the glossary in specs. You SHALL organize /docs by topic, not by component. You SHALL include practical examples for each feature documented. You SHOULD update documentation when related specifications change. You SHOULD include troubleshooting sections for common issues. You SHALL clarify open points with user. You MAY use todos and tools as needed.
Double-check the last work, whether it be a plan, design, or implementation, ensuring all aspects have been fully considered. Use when user wants to check work, or mentions "double check".
Align source with target. Use this when asked to align, check, or verify alignment between artifacts.
Create or update ARCHITECTURE.md. Use this when asked to create, update or modify the project architecture.
Brainstorm ideas, explore solutions, and evaluate options. Use this when asked to brainstorm, explore ideas, or analyze trade-offs.
Run traceability and schema checks, then fix any errors. Use this when asked to check, validate, or fix traceability and schema issues.
Implement code and tests based on architecture, requirements, and design (or a set of tasks). Use this when asked to implement features, write code, or create tests.