alexei-led/documenting-code

<!-- generated by scripts/build/generate-skills.py — edits to this file will be overwritten by `make build`. Edit the canonical SKILL.md (or add a SKILL.codex.md / SKILL.pi.md sidecar to diverge). --> <!-- Platform guidance for non-Claude models (Codex CLI, Gemini CLI) --> <!-- Persistence: Keep going until the task is fully resolved. Do not stop at the first obstacle. --> <!-- Tool use: Use available tools to verify — do not guess at file contents, paths, or command output. --> <!-- Planning: Reflect between steps. Decompose complex problems into logical sub-steps before acting. --> <!-- Reliability: Assess risk before irreversible actions. Ask for clarification on ambiguity. --> <!-- Completeness: Generate complete responses without truncating. Review your output against the original constraints. -->

Documentation Update

Update project documentation to reflect current code state. Do not delete or overwrite existing docs without confirmation. If verification fails or required evidence is unavailable, report the failure instead of claiming docs are current.

1. Determine documentation scope
2. Analyze recent changes
3. Analyze and update documentation
4. Verify examples and links
5. Verify and report

---

Phase 1: Determine Scope

Ask one question at a time:

| Header | Question | Options | | --------- | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Doc scope | What documentation should I update? | 1. Auto-detect - Scan for outdated docs based on recent changes 2. README - Update project README 3. API docs - Update API/function documentation 4. All - Comprehensive documentation refresh |

Phase 2-4: Analyze and Update Documentation

Use a documentation subagent when available; otherwise inspect and update docs directly.

Phase 4: Research Best Practices (If Needed)

Use available docs lookup tools for GoDoc, Sphinx, or framework-specific documentation patterns.

Phase 5: Verify and Present Summary

Independent verification (do not trust the agent's self-report):

When describing parent verification, explicitly mention checking runnable code examples or documented commands when practical. If examples/commands cannot be run, state why.

1. Run git diff --stat to confirm files were actually changed
2. For each changed file, verify the diff looks correct (no broken links, no placeholder text)
3. Run or compile documented code examples and commands when practical; if not practical, state why the check was skipped
4. If no files changed, report that no documentation modifications were needed

Report what was updated, verified diffs, and any issues found.

If no recent changes are found or documentation scope is unclear, ask the user what to document rather than generating speculative documentation.

Execute documentation update now.