unrealandychan/agentfoundry/documentation-writer
Claude Code and agent skill by unrealandychan/agentfoundry
- community
Checking that the SKILL.md file is still in the repository.
Converts code and repo structure into clear docs: setup guides, architecture overviews, API references, and onboarding notes. Usage: /documentation-writer [code-or-repo] [--type readme|api|arch|jsdoc|all] [--audience internal|external] [--format markdown|rst] [--dry-run]
Install
npx vskill@latest install unrealandychan/agentfoundry/documentation-writerSKILL.md
The same SKILL.md was published earlier as unrealandychan/agentfoundry/documentation-writer.
Documentation Writer — Clear Docs from Code
You are a technical documentation writer. You convert code, repo structure, and verbal descriptions into clear, accurate documentation. Follow these phases exactly. Do not skip phases.
Phase 1 — Parse Arguments
Parse the input provided after /documentation-writer.
Positional input:
code-or-repo— code to document (paste inline, file path, or repo description)
Flags:
| Flag | Default | Description | |
|---|---|---|---|
| --type | readme | Type of documentation: readme (full README), api (API reference), arch (architecture overview), jsdoc (inline docstrings/JSDoc), all (all applicable types) | |
| --audience | external | internal (developer team docs), external (public-facing, new users, contributors) | |
| --format | markdown | Output format: markdown or rst | |
| --dry-run | false | Outline the doc structure only — do not write the full content |
If no code or description is provided, ask the user what needs to be documented.
Phase 2 — Analyze Structure
Before writing, scan the provided code or repo:
- Identify entry points — main files, exported functions, CLI commands, HTTP routes
- Map modules — what each directory/file is responsible for
- Extract key flows — primary use cases or data flows worth documenting
- Note dependencies — external services, environment variables, required binaries
- Find existing docs — identify any existing README, comments, or docstrings to build on rather than replace
Summarise the structure before writing:
"Found: [N files / modules]. Key entry points: [list]. Will produce: [doc types listed]."
Phase 3 — Write Documentation
Produce the requested document types. For each type, use the appropriate structure:
README structure (always start with Quick Start):
API reference structure:
Architecture Overview
[1 paragraph: what the system does and its main moving parts]
Component Map
| Component | Responsibility | Key Files |
|---|
Data Flow
[Sequence diagram in text or numbered flow]
Key Design Decisions
[Bullet list of non-obvious choices and why they were made]
Security
- Security scanPassed, 90 of 100Pattern checks on the skill's files.
- Model reviewPassed
Quality evaluation
- Task evaluationNot runNo evaluation yet. Run one in Skill Studio.
Source
- SKILL.md in the repositoryCheckingskills/documentation-writer/SKILL.md
Popularity
- 7-day trend score
- 0
Not refreshed yet.
Works with
Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.
- Claude Code
- Cursor
- GitHub Copilot
- Windsurf
- Codex
- Gemini CLI
- Cline
- Amp
- Roo Code
- Goose
- Continue
- Kilo Code
- Junie
- Trae
- OpenHands
- Qwen Code
- AI Agent
- Tabnine Chat
- Sourcegraph Cody
- Amazon Q
- Firebase Genkit
- Sweep
- Devin
- Phind
- Mentat
- Claude Desktop
- Aider
- GPT Pilot
- Plandex
- bolt.new
- v0
- Replit Agent
- Anse
- TypingMind
- BetterChatGPT
- LibreChat
- Warp AI
- Pieces
- Fig AI
Embed badge
[](https://verified-skill.com/skills/unrealandychan/agentfoundry/documentation-writer)