Reverse Document
Create technical documentation from existing implementation using the shared canonical templates.
Install
$ agentstack add skill-avelrl-skills-reverse-document ✓ scanned · ✓ verified, works with Claude Code, Cursor, and more.
Security review
✓ PassedNo issues found. Passed automated security review. · v0.1.0 How review works →
- ✓ Prompt-injection patterns
- ✓ Secret / credential exfiltration
- ✓ Dangerous shell & filesystem operations
- ✓ Untrusted network calls
- ✓ Known-malicious package signatures
What it can access
- ✓ Network access No
- ✓ Filesystem access No
- ✓ Shell / process execution No
- ✓ Environment & secrets No
- ✓ Dynamic code execution No
From automated source analysis of v0.1.0. “Used” means the capability is present in the source — more access means more to trust, not that it’s unsafe.
Verified badge
Passed review? Show it. Paste this badge into your README, it links to the public security report.
Links to your public security report.[](https://agentstack.voostack.com/security/report/skill-avelrl-skills-reverse-document) Reliability & compatibility
Declared compatibility
Compatibility is declared by the source manifest. End-to-end runtime verification is coming, see below.
We're building live execution health for every listing: tool-call success rate, median latency, uptime, and last-checked timestamps, measured, not self-reported. It isn't live yet, so we don't show numbers we can't stand behind.
How agent discovery & health will work →About
Purpose: Recover shared technical documentation from existing implementation without inventing intent.
Use when:
- code exists first and a technical design or architecture doc is missing
- you need a defendable document based on implementation facts
Do not use for:
- speculative design before implementation
- game-system reverse docs that belong to
gamedev/ - user-story or product requirement writing
Inputs / Required Context:
- required: `` and a real code or module path
- read: target path plus nearby code, tests, configs, and relevant docs
- ask only for intent that cannot be recovered from implementation
Outputs / Owned Artifacts:
- owns
docs/design/[slug].mdfortechnical-design - owns
docs/architecture/adr-[NNNN]-[slug].mdforarchitecture - creates
docs/design/ordocs/architecture/if needed - uses shared templates only
Modes or Arguments:
technical-design|designarchitecture
Execution Rules:
- Validate the type and target path.
- Read only the material needed to document responsibilities, interfaces, data flow, dependencies, edge cases, and constraints.
- Add a short reverse-documentation context near the top of the doc.
- For architecture outputs, determine the next ADR number before saving.
- Save the result to the canonical shared path.
Failure / Stop Conditions:
- stop if the path does not exist or the type is unsupported
- stop and redirect if the request is actually a game-system design doc
- if rationale cannot be proven, mark it as inferred or open instead of pretending certainty
Return Format:
- source path
- output path
- what is now documented
- what is still inferred or unresolved
- what should be reviewed next
Example Invocation:
/reverse-document technical-design src/auth/refresh.go
Related Skills / Boundary:
- use
architecture-decisionwhen the main task is making or updating an ADR - do not pull game-specific templates or rules into this shared skill
Source & license
This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.
- Author: avelrl
- Source: avelrl/skills
- License: MIT
Install and usage instructions live in the source repository linked above.
Reviews
No reviews yet, be the first.
Write a review
Versions
- v0.1.0 Imported from the upstream source.