Documentation Specialist Skill
A technical documentation skill: SRS, PRD, SDD and OpenAPI from templates, reverse generation from code and quality audit.
- 55 ★ on the repository
- Last commit
Minimal access
Why this level
- The skill reads project code and writes documents into the repository.
Install
- Works in
In your terminal, with SkillFoxx CLI
npx skillfoxx add skills/documentation-specialist-skillDetects the agents on your machine, shows the access level and pins the version.
Other ways to install
Access and checks
How we reviewMinimal accessThe tool runs nothing and makes no network calls.
- The skill reads project code and writes documents into the repository.
This is third-party code. Review the repository files before installing.
What it does
Documentation Specialist turns Claude Code into a software documentation specialist and uses progressive disclosure (PDA) to spend fewer tokens. The greenfield mode creates documents from templates: SRS per IEEE 830, PRD, SDD per arc42, OpenAPI 3.0 and an architecture overview per C4. The reverse mode builds documentation from existing code: for Spring Boot controllers become OpenAPI, entities become ER diagrams and services become an SDD, and for Pulumi infrastructure resources go into deployment documents. A third mode audits quality: checklists, completeness scoring, comparison with IEEE, OpenAPI and WCAG practices, recommendations and automatic fixes for common issues. Output is Markdown, and DOCX and PDF come through neighboring skills. Diagrams are built in Mermaid, with PlantUML used for wireframes, use case diagrams and ArchiMate.
Who it is for. Developers, technical writers and analysts who need requirements, design and API documentation without assembling templates by hand.
Good fit when
- An SRS per IEEE 830 is written for a payment system.
- An OpenAPI spec and a database schema are built from Spring Boot controllers.
- Existing documentation is checked for completeness and a fix list is produced.
- C4 diagrams in Mermaid are drawn for an architecture.
Not a fit when
- You need marketing or legal documentation.
- The project uses a stack without ready code mapping.
- You need a finished DOCX without installing neighboring skills.
Example request
Create a Software Requirements Specification for a payment system per IEEE 830 and save it in docs/.Limitations
Full code to document mapping currently exists for Spring Boot and Pulumi. FastAPI, Express.js, Django, Flask, Terraform, AWS CDK, React, Next.js, Vue.js, Python ETL and Airflow are marked planned in the README. DOCX and PDF use the separate `docx` and `pdf` skills and diagrams use `design-doc-mermaid` and `plantuml`. The repository states no license, so check the terms of use. Review generated documents: the skill builds them from code and templates rather than from your team knowledge.
How to disable. Delete the `document-specialist-skill` folder from `~/.claude/skills/` or disable the plugin with Claude Code commands. Created documents stay in the project.
FAQ
How do I install the skill in Claude Code?
Run `claude plugin marketplace add SpillwaveSolutions/document-specialist-skill` and `claude plugin install document-specialist`. You can also clone the repository into `~/.claude/skills`.
Which documents does it create?
SRS per IEEE 830, PRD, SDD per arc42, an OpenAPI 3.0 spec and a C4 architecture overview. User guides and deployment documents are templates for now.
Which code can documentation be built from?
Spring Boot and Pulumi are fully mapped. Other frameworks are marked planned in the README.
Does it work in Codex and Cursor?
Yes, the repository has `.codex-plugin`, `.cursor-plugin` and a root `plugin.json` per the Agent Plugins 1.0 standard.
How do I install through Skilz?
Run `skilz install SpillwaveSolutions_document-specialist-skill/documentation-specialist`.
Discussion
No questions or reviews yet.
Related
Skills16 ready skills for Cursor, Claude Code and Codex: theses, PDF and Office, draw.io diagrams, project documentation
Four Claude Code and Codex skills: Word with tracked changes, PDF forms and OCR, PowerPoint from HTML, Excel recalculation.
The official Kingsoft Docs (WPS) skill set: Claude Code and Codex create and edit cloud documents through kdocs-cli
A skill that typesets resumes, one-pagers, letters, reports and slides from templates into PDF, PNG and PPTX and checks the result before delivery
A skill that draws validated architecture, workflow, sequence and data-flow diagrams as one interactive HTML file
A skill for Chinese technical writing: rewrites docs, interface strings and API descriptions, keeps the facts intact and checks output with a linter
README in short
The docs describe version 3.3.1, install methods for four hosts, three working modes and example requests. A 44–72 percent token reduction against version 1.0 is claimed.
README badge
Original SKILL.md
--- name: "documentation-specialist" description: | This skill should be used when creating professional software documentation (SRS, PRD, OpenAPI, SDD, architecture docs, user manuals, tutorials, runbooks) from templates (greenfield) or reverse-engineering documentation from existing code like Spring Boot or FastAPI (brownfield). Also handles documentation audits/reviews, format conversion (Markdown, DOCX, PDF), and diagram generation (Mermaid first: C4, sequence, class, ER, state, flowchart; PlantUML Salt for UI wireframes and leftover UML). Use when asked to "create documentation", "document my code", "write SRS", "generate PRD", "write DESIGN_DOC.md", "architecture document", "wireframe", or "documentation specialist". version: "3.3.1" allowed-tools: ["Read", "Write", "Edit", "Glob", "Grep", "Bash", "Skill"] --- # Documentation Specialist Skill ## Quick Start Software documentation creation, extraction, conversion, and diagramming capabilities. **Capabilities:** 1. **Greenfield** - Create documentation from templates (SRS, PRD, SDD/DESIGN_DOC.md, architecture, OpenAPI, User Manuals, Tutorials, Runbooks) 2. **Brownfield** - Reverse-engineer documentation from code (Spring Boot, FastAPI) 3. **Audit** - Review and improve existing documentation 4. **Convert** - Transform formats (MD to DOCX to PDF) 5. **Diagram** - Mermaid first (C4, sequence, class, ER, state, flowchart). PlantUML Salt for UI wireframes. PlantUML for leftover UML (use case, timing, ArchiMate, nwdiag, WBS). **Example Requests:** ``` Create an SRS for a billing system with PCI-DSS compliance Write DESIGN_DOC.md for this repository using arc42 Create an architecture document with C4-style Mermaid Document my Spring Boot application at ~/projects/customer-api Create a user manual for my SaaS product Write a database failover runbook Audit my API documentation at docs/api/openapi.yaml Convert docs/srs.md to Word format Create a C4 container diagram for my microservices Draw a login wireframe ``` **Execution Flow:** 1. Classify intent to 2. Choose one voice pack to 3. Load workflow to 4. Execute steps to 5. Generate documentation to 6. Present post-processing options ---