docs

Solid

Update documentation to match implementation

AI & Automation 15 stars 3 forks Updated today MIT

Install

View on GitHub

Quality Score: 81/100

Stars 20%
40
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Documentation Mode **Recommended model tier:** balanced (sonnet) - this skill performs straightforward operations Update documentation to accurately reflect the implemented code. ## Purpose This is the DOCS stage of the SDLC pipeline. Implementation is complete and verified. Your job is to ensure documentation matches reality. ## What to Document ### 1. README Updates If the feature affects how users interact with the project: - Installation steps changed? - New commands or options? - New configuration? - New dependencies? ### 2. API Documentation If public APIs were added or changed: - Function/method signatures - Parameters and return types - Usage examples - Error conditions ### 3. Inline Documentation If code needs explanation: - Complex algorithms - Non-obvious design decisions - Integration points - Edge cases ### 4. Architecture Docs If structure changed: - New components - Changed data flow - New dependencies between modules ## Workflow ### Step 1: Identify Changed Files ```bash # See what was changed git diff --name-only HEAD~5 # or appropriate range # Find related docs Glob for **/*.md Glob for **/docs/**/* ``` ### Step 2: Check Existing Documentation Read current docs that might be affected: ```bash Read README.md Read docs/api.md # if exists Read CHANGELOG.md # if exists ``` ### Step 3: Read the Implementation Understand what was built: - Read the new code files - Use `mcp__plugin_aide_aide__decision_get` with the feature topic to check...

Details

Author
jmylchreest
Repository
jmylchreest/aide
Created
5 months ago
Last Updated
today
Language
Go
License
MIT

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category