Stats
Actions
Tags
From aide
Updates README, API documentation, inline comments, and architecture docs to match implemented code. Use in DOCS stage after implementation and verification.
How this skill is triggered — by the user, by Claude, or both
Slash command
/aide:docsThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
**Recommended model tier:** balanced (sonnet) - this skill performs straightforward operations
Recommended model tier: balanced (sonnet) - this skill performs straightforward operations
Update documentation to accurately reflect the implemented code.
This is the DOCS stage of the SDLC pipeline. Implementation is complete and verified. Your job is to ensure documentation matches reality.
If the feature affects how users interact with the project:
If public APIs were added or changed:
If code needs explanation:
If structure changed:
# See what was changed
git diff --name-only HEAD~5 # or appropriate range
# Find related docs
Glob for **/*.md
Glob for **/docs/**/*
Read current docs that might be affected:
Read README.md
Read docs/api.md # if exists
Read CHANGELOG.md # if exists
Understand what was built:
mcp__plugin_aide_aide__decision_get with the feature topic to check design decisionsmcp__plugin_aide_aide__decision_list to see all decisionsAdd/update sections as needed:
## New Feature
Description of what it does.
### Usage
\`\`\`bash
command --new-flag
\`\`\`
### Configuration
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| newOption | string | "default" | What it does |
Document public interfaces:
### functionName(param1, param2)
Brief description.
**Parameters:**
- `param1` (string): What it is
- `param2` (number, optional): What it does. Default: 10
**Returns:** `Promise<Result>`
**Example:**
\`\`\`typescript
const result = await functionName("input", 20);
\`\`\`
**Throws:**
- `ValidationError`: When param1 is empty
Add comments for non-obvious code:
// Use exponential backoff to handle rate limiting
// Starts at 100ms, doubles each retry, max 5 retries
async function fetchWithRetry(url: string): Promise<Response> {
// ...
}
# If docs have a build step
npm run docs:build
# Check for broken links (if tool available)
npm run docs:check
# Manual review - read what you wrote
git add -A
git commit -m "docs: document <feature>"
## Documentation Updates
### Files Modified
- `README.md` - Added new feature section
- `docs/api.md` - Documented new endpoints
- `src/service.ts` - Added inline comments for complex logic
### Summary of Changes
1. Added usage instructions for `--new-flag`
2. Documented `createUser` API with examples
3. Updated configuration table with new options
### Verification
- [ ] Docs build successfully
- [ ] Examples are copy-pasteable and work
- [ ] No broken internal links
If this is a new project without docs structure:
If docs build fails:
Before completing:
When documentation is complete:
Documentation complete.
- Updated: [list of files]
- Added: [new sections/files]
SDLC pipeline complete for this story.
[DESIGN] → [TEST] → [DEV] → [VERIFY] → [DOCS]
↑
YOU ARE HERE
npx claudepluginhub jmylchreest/aide --plugin aideGuides documentation after feature implementation or bug fixes: search knowledge base for conventions, update ARCHITECTURE.md and TESTING.md, write ADRs for decisions.
Routes documentation tasks to code comments (audit/cleanup) or system docs (READMEs, API docs, architecture). Use for writing, auditing, or improving any docs.