majiayu000/claude-arsenal
xiaohongshu
xiaohongshu
286 148
View 
Documentation Specialist Skill
documentation-specialist
This skill should be used when creating professional software documentation (SRS, PRD, OpenAPI, user manuals, tutorials, runbooks) from templates (greenfield) or reverse-engineering documentation from existing code like Spring Boot or FastAPI (brownfield). Also handles documentation audits/review...
SKILL.md
Full skill instructions
Documentation Specialist Skill
Quick Start
Software documentation creation, extraction, conversion, and diagramming capabilities.
Capabilities:
- Greenfield - Create documentation from templates (SRS, PRD, OpenAPI, User Manuals, Tutorials, Runbooks)
- Brownfield - Reverse-engineer documentation from code (Spring Boot, FastAPI)
- Audit - Review and improve existing documentation
- Convert - Transform formats (MD → DOCX → PDF)
- Diagram - Generate visuals (Mermaid C4, PlantUML UML)
Example Requests:
Create an SRS for a billing system with PCI-DSS compliance
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
Execution Flow:
- Classify intent → 2. Load workflow → 3. Execute steps → 4. Generate documentation → 5. Present post-processing options
Intent Classification
| Intent | Keywords | Workflow |
|---|---|---|
| CREATE_NEW | "create", "generate", "write" + doc type | greenfield-workflow.md |
| CODE_TO_DOCS | "document", "extract", path reference | brownfield-workflow.md |
| AUDIT | "audit", "review", "check", "improve" | audit-workflow.md |
| CONVERT | "convert", "to Word", "to PDF" | convert-workflow.md |
| DIAGRAM | "diagram", "C4", "sequence", "ER" | diagram-workflow.md |
| USER_DOCS | "user manual", "how-to", "getting started" | user-docs-workflow.md |
| TUTORIAL | "tutorial", "API guide", "CLI docs" | tutorial-workflow.md |
| RUNBOOK | "runbook", "procedure", "incident" | runbook-workflow.md |
CRITICAL: Load only the workflow needed for the current intent. Avoid loading multiple workflows.
Document Type → Template
Requirements & Design:
| Type | Template |
|---|---|
| SRS | requirements-srs.md |
| PRD | requirements-prd.md |
| OpenAPI | api-openapi.yaml |
User Documentation:
| Type | Template |
|---|---|
| User Manual | user-manual.md |
| How-To Guide | howto-guide.md |
| Getting Started | getting-started.md |
Developer & Operations:
| Type | Template |
|---|---|
| Developer Tutorial | developer-tutorial.md |
| Runbook | runbook.md |
Framework Detection (Brownfield)
| Framework | Detection | Mapping |
|---|---|---|
| Spring Boot | pom.xml, @SpringBootApplication | spring-boot-mapping.yaml |
| FastAPI | requirements.txt, from fastapi import | fastapi-mapping.yaml |
Process: Glob for detection files → Grep for patterns → Load mapping → Follow brownfield workflow
On-Demand Resources
Load only what is needed for the current task.
Workflows
- Workflow TOC - Navigation index
- greenfield-workflow.md
- brownfield-workflow.md
- audit-workflow.md
- convert-workflow.md
- diagram-workflow.md
- user-docs-workflow.md
- tutorial-workflow.md
- runbook-workflow.md
Reference Guides
- comprehensive-guide.md - Navigation to all 27 reference guides
Examples
- Examples TOC - Navigation to all examples
Skill Integration
| Skill | Invocation Trigger |
|---|---|
| docx | Request includes Word format |
| Request includes PDF format | |
| plantuml | UML diagrams (ER, sequence, component) |
| mermaid-architect | C4 diagrams, flowcharts |
Error Handling
| Error | Response |
|---|---|
| Cannot detect framework | Ask: "Is this Spring Boot, FastAPI, or another framework?" |
| Missing template | Use closest match, inform user |
| Skill not available | Offer markdown-only alternative |
| Ambiguous request | Ask: "Would you prefer SRS (formal) or PRD (agile)?" |
End of SKILL.md (v3.0-PDA)
More skills from majiayu000
majiayu000/claude-arsenal
technical-spec
technical spec
286 141
View majiayu000/claude-arsenal
product-ux-expert
product ux expert
286 133
View majiayu000/claude-arsenal
database-patterns
database patterns
286 119
View majiayu000/claude-skill-registry
agent-task-conductor
Conduct multi-agent task orchestration and workflow coordination.
663 1
View majiayu000/claude-skill-registry
conductor-setup
Initialize project with Conductor artifacts (product definition,
663 1
View majiayu000/claude-skill-registry
animation-designer
Expert in web animations, transitions, and motion design using Framer Motion and CSS
663 1
View majiayu000/claude-skill-registry
diagramming
Creates Mermaid and ASCII diagrams for flowcharts, architecture, ERDs, state machines, mindmaps, and more. Use when user mentions diagram, flowchart, mermaid, ASCII diagram, text diagram, terminal diagram, visualize, C4, mindmap, architecture diagram, sequence diagram, ERD, or needs visual docume...
663 1
View majiayu000/claude-skill-registry-data
h3-pg
PostgreSQL bindings for H3 hexagonal grid system. Use when working with H3 cells in Postgres, including spatial indexing, geometry/geography integration, and raster analysis.
23 1
View majiayu000/claude-skill-registry
conductor-development
Context-Driven Development skill for projects using Conductor. Use this skill when you detect a `conductor/` directory in the project, when working on tasks defined in a `plan.md` file, or when the user asks about tracks, specs, or plans. Automatically applies TDD workflow, tracks task completion...
663 1
View majiayu000/claude-skill-registry
conductor-status
Display project status, active tracks, and next actions
663 1
View majiayu000/claude-skill-registry
dockerization
Official Stakpak application containerization standard operating procedure, a step-by-step guidline to properly dockerize applications. This is a rule book curated by the Stakpak Team.
663 1
View Popular AI tools
Video
Kaiber
Generate, edit, and beat-sync AI video with leading models in one workspace.
Paid
View Productivity
Vimcal
The world's fastest calendar for remote work
Free
View Images
IMGCreator.ai
Transform Your Design with AI Designer by ImgCreator.ai
Freemium
View Content & writing
Akool AI
Revolutionizing Video Production with AI-Powered Creativity
Paid
View Images
Clipdrop Uncrop
Extend an image past the frame and let AI fill the new aspect ratio.
Freemium
View Security
StarByFace
Discover your celebrity doppelgänger with StarByFace!
Free
View C
Finance
ChainClarity
ChainClarity explains 700+ crypto whitepapers in plain English, with layered summaries, comparisons, research tools, alerts, and a $4.99 Pro plan.
Freemium
View Coding & apps
Opus Clip
Opus.ai: Revolutionize Your Web Experience
Free
View