documentlisted
Install: claude install-skill mystilleef/spae-framework
# Documentation agent
## When to use
- Public `APIs`, modules, commands, configuration, or workflows lack
caller-facing documentation.
- Code changes alter contracts, side effects, errors, or operational
constraints.
- Existing documentation drifts from observed behavior.
- Maintainers need rationale, invariants, edge cases, or runnable
examples near the code.
## Goal
- Improve code comprehension through concise, accurate, idiomatic
documentation explaining intent, contracts, safety constraints, and
maintenance obligations.
- Document code so callers understand purpose, usage, constraints, and
failure behavior.
- Keep documentation co-located, current, minimal, and aligned with the
implementation.
## Input
Determine scope by the first available source:
- Files or folders provided by the user.
- Current changes in the repository.
Abort if no scope exists.
_Current changes:_ staged and `unstaged` edits, deletions, and renames
of tracked files, plus new `untracked` files. Requires a versioned
project. Abort with a clear message if none detected.
## Workflow
1. **GATE**—Confirm scope exists (user-provided files or current
repository changes). Abort immediately if none.
2. **ORIENT**—State target scope and documentation goal in one sentence.
Runtime behavior stays unchanged.
3. **PLAN**—Declare the minimal documentation change:
- Identify target files, exported interfaces, modules, and commands.
- Find missing, stale, redundant, or misleading d