document

Write and update caller-facing documentation for code APIs, modules, and behavior.

1|Updated May 12, 2026
One-click install
npx skills add https://github.com/mystilleef/spae-framework --skill document-mystilleef
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document
Source: https://github.com/mystilleef/spae-framework/tree/main/skills/document
Command: npx skills add https://github.com/mystilleef/spae-framework --skill document-mystilleef

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Codebases often ship with missing, stale, or misleading documentation, forcing maintainers and callers to reverse-engineer intent, contracts, and failure behavior from source code. This Skill closes that gap by generating accurate, minimal, caller-facing documentation that stays aligned with the actual implementation. ## Core Features & Use Cases - Scoped Documentation: Documents user-specified files or automatically detects current repository changes (staged, unstaged, and untracked edits) as the documentation scope. - Contract-Focused Writing: Covers purpose, parameters, return values, errors, side effects, invariants, edge cases, and runnable examples while removing stale or speculative prose. - Verification Loop: Compares every documentation claim against code, tests, and project conventions before persisting changes, guaranteeing no behavioral drift. - Use Case: After refactoring a public API module, run this Skill to update all affected docstrings and comments so they reflect the new contracts, error modes, and usage examples. ## Quick Start Document the public APIs and changed behavior in the files I just modified in this repository.

Frequently Asked Questions about document

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document code APIs and modules automatically?▼

Provide the target files or let the Skill detect current repository changes as scope. It writes caller-facing documentation covering purpose, parameters, returns, errors, side effects, and invariants, then verifies each claim against the code before saving.

How to keep documentation in sync with code changes?▼

Run the Skill after modifying code so it scopes to your staged, unstaged, and untracked changes. It updates docs for altered contracts and failure behavior, and deletes stale, redundant, or speculative prose that no longer matches the implementation.

Does documenting code change runtime behavior?▼

No. The Skill enforces a strict no-behavioral-changes constraint: it only adds, updates, or removes documentation prose. Runtime logic, signatures, and side effects remain untouched throughout the workflow.

What happens if there are no files or changes to document?▼

The Skill aborts immediately with a clear message. Scope comes from user-provided files or current repository changes, and it requires a versioned project to detect changes automatically.

When should I not use automated code documentation?▼

Avoid it for private implementation details that callers never touch, since the Skill focuses on public contracts. It also describes only observed behavior, so it will not document planned or speculative features.