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 |
| pdf |
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)?" |
Antigravity Integration
This skill is compatible with Antigravity IDE. When running in Antigravity, use the following adaptations.
Tool Mapping
| Claude Code Tool |
Antigravity Equivalent |
Usage |
Read |
view_file, view_file_outline |
Read skill files, templates, references |
Write |
write_to_file |
Create new documentation files |
Edit |
replace_file_content, multi_replace_file_content |
Edit existing docs |
Glob |
find_by_name |
Search for files by pattern |
Grep |
grep_search |
Search content within files |
Bash |
run_command |
Execute shell commands |
Skill |
view_file (read another skill's SKILL.md) |
Chain to other skills |
Path Resolution
In Antigravity, resolve all relative paths from the skill base directory:
~/.gemini/antigravity/skills/document-specialist/
Example: references/templates/markdown/requirements-srs.md resolves to:
~/.gemini/antigravity/skills/document-specialist/references/templates/markdown/requirements-srs.md
For sub-workflow cross-references (e.g., greenfield/srs-guide.md inside greenfield-workflow.md), resolve relative to the referencing file's directory, not the skill root.
Fallback Behavior (Missing Skills)
| Requested Feature |
Missing Skill |
Fallback |
| Export to Word (DOCX) |
docx |
Inform user DOCX not available; offer Markdown output |
| Export to PDF |
pdf |
Inform user PDF not available; offer Markdown output |
| PlantUML diagrams (ER, sequence) |
plantuml |
Generate Mermaid syntax inline (Antigravity supports Mermaid rendering) |
| C4 diagrams, flowcharts |
mermaid-architect |
Generate Mermaid syntax inline directly |
End of SKILL.md (v3.0-PDA, Antigravity-adapted)
Source: phamvantienkiz/agent_setup — distributed by TomeVault.
1---2name: phamvantienkiz-agent-setup-documentation-specialist3description: Documentation Specialist Skill4---56# Documentation Specialist Skill78## Quick Start910Software documentation creation, extraction, conversion, and diagramming capabilities.1112**Capabilities:**13141. **Greenfield** - Create documentation from templates (SRS, PRD, OpenAPI, User Manuals, Tutorials, Runbooks)152. **Brownfield** - Reverse-engineer documentation from code (Spring Boot, FastAPI)163. **Audit** - Review and improve existing documentation174. **Convert** - Transform formats (MD → DOCX → PDF)185. **Diagram** - Generate visuals (Mermaid C4, PlantUML UML)1920**Example Requests:**2122```23Create an SRS for a billing system with PCI-DSS compliance24Document my Spring Boot application at ~/projects/customer-api25Create a user manual for my SaaS product26Write a database failover runbook27Audit my API documentation at docs/api/openapi.yaml28Convert docs/srs.md to Word format29Create a C4 container diagram for my microservices30```3132**Execution Flow:**33341. Classify intent → 2. Load workflow → 3. Execute steps → 4. Generate documentation → 5. Present post-processing options3536---3738## Intent Classification3940| Intent | Keywords | Workflow |41|--------|----------|----------|42| **CREATE_NEW** | "create", "generate", "write" + doc type | [greenfield-workflow.md](references/workflows/greenfield-workflow.md) |43| **CODE_TO_DOCS** | "document", "extract", path reference | [brownfield-workflow.md](references/workflows/brownfield-workflow.md) |44| **AUDIT** | "audit", "review", "check", "improve" | [audit-workflow.md](references/workflows/audit-workflow.md) |45| **CONVERT** | "convert", "to Word", "to PDF" | [convert-workflow.md](references/workflows/convert-workflow.md) |46| **DIAGRAM** | "diagram", "C4", "sequence", "ER" | [diagram-workflow.md](references/workflows/diagram-workflow.md) |47| **USER_DOCS** | "user manual", "how-to", "getting started" | [user-docs-workflow.md](references/workflows/user-docs-workflow.md) |48| **TUTORIAL** | "tutorial", "API guide", "CLI docs" | [tutorial-workflow.md](references/workflows/tutorial-workflow.md) |49| **RUNBOOK** | "runbook", "procedure", "incident" | [runbook-workflow.md](references/workflows/runbook-workflow.md) |5051**CRITICAL**: Load only the workflow needed for the current intent. Avoid loading multiple workflows.5253---5455## Document Type → Template5657**Requirements & Design:**5859| Type | Template |60|------|----------|61| SRS | [requirements-srs.md](references/templates/markdown/requirements-srs.md) |62| PRD | [requirements-prd.md](references/templates/markdown/requirements-prd.md) |63| OpenAPI | [api-openapi.yaml](references/templates/markdown/api-openapi.yaml) |6465**User Documentation:**6667| Type | Template |68|------|----------|69| User Manual | [user-manual.md](references/templates/markdown/user-manual.md) |70| How-To Guide | [howto-guide.md](references/templates/markdown/howto-guide.md) |71| Getting Started | [getting-started.md](references/templates/markdown/getting-started.md) |7273**Developer & Operations:**7475| Type | Template |76|------|----------|77| Developer Tutorial | [developer-tutorial.md](references/templates/markdown/developer-tutorial.md) |78| Runbook | [runbook.md](references/templates/markdown/runbook.md) |7980---8182## Framework Detection (Brownfield)8384| Framework | Detection | Mapping |85|-----------|-----------|---------|86| **Spring Boot** | `pom.xml`, `@SpringBootApplication` | [spring-boot-mapping.yaml](references/mappings/backend/spring-boot-mapping.yaml) |87| **FastAPI** | `requirements.txt`, `from fastapi import` | [fastapi-mapping.yaml](references/mappings/backend/fastapi-mapping.yaml) |8889**Process**: Glob for detection files → Grep for patterns → Load mapping → Follow brownfield workflow9091---9293## On-Demand Resources9495Load only what is needed for the current task.9697### Workflows9899- [Workflow TOC](references/workflows/TOC.md) - Navigation index100- [greenfield-workflow.md](references/workflows/greenfield-workflow.md)101- [brownfield-workflow.md](references/workflows/brownfield-workflow.md)102- [audit-workflow.md](references/workflows/audit-workflow.md)103- [convert-workflow.md](references/workflows/convert-workflow.md)104- [diagram-workflow.md](references/workflows/diagram-workflow.md)105- [user-docs-workflow.md](references/workflows/user-docs-workflow.md)106- [tutorial-workflow.md](references/workflows/tutorial-workflow.md)107- [runbook-workflow.md](references/workflows/runbook-workflow.md)108109### Reference Guides110111- [comprehensive-guide.md](references/reference/comprehensive-guide.md) - Navigation to all 27 reference guides112113### Examples114115- [Examples TOC](references/examples/TOC.md) - Navigation to all examples116117---118119## Skill Integration120121| Skill | Invocation Trigger |122|-------|-------------------|123| **docx** | Request includes Word format |124| **pdf** | Request includes PDF format |125| **plantuml** | UML diagrams (ER, sequence, component) |126| **mermaid-architect** | C4 diagrams, flowcharts |127128---129130## Error Handling131132| Error | Response |133|-------|----------|134| Cannot detect framework | Ask: "Is this Spring Boot, FastAPI, or another framework?" |135| Missing template | Use closest match, inform user |136| Skill not available | Offer markdown-only alternative |137| Ambiguous request | Ask: "Would you prefer SRS (formal) or PRD (agile)?" |138139---140141## Antigravity Integration142143This skill is compatible with **Antigravity IDE**. When running in Antigravity, use the following adaptations.144145### Tool Mapping146147| Claude Code Tool | Antigravity Equivalent | Usage |148|-----------------|----------------------|-------|149| `Read` | `view_file`, `view_file_outline` | Read skill files, templates, references |150| `Write` | `write_to_file` | Create new documentation files |151| `Edit` | `replace_file_content`, `multi_replace_file_content` | Edit existing docs |152| `Glob` | `find_by_name` | Search for files by pattern |153| `Grep` | `grep_search` | Search content within files |154| `Bash` | `run_command` | Execute shell commands |155| `Skill` | `view_file` (read another skill's SKILL.md) | Chain to other skills |156157### Path Resolution158159In Antigravity, resolve all relative paths from the skill base directory:160161```162~/.gemini/antigravity/skills/document-specialist/163```164165Example: `references/templates/markdown/requirements-srs.md` resolves to:166167```168~/.gemini/antigravity/skills/document-specialist/references/templates/markdown/requirements-srs.md169```170171For sub-workflow cross-references (e.g., `greenfield/srs-guide.md` inside `greenfield-workflow.md`), resolve relative to the **referencing file's directory**, not the skill root.172173### Fallback Behavior (Missing Skills)174175| Requested Feature | Missing Skill | Fallback |176|-------------------|--------------|----------|177| Export to Word (DOCX) | `docx` | Inform user DOCX not available; offer Markdown output |178| Export to PDF | `pdf` | Inform user PDF not available; offer Markdown output |179| PlantUML diagrams (ER, sequence) | `plantuml` | Generate **Mermaid** syntax inline (Antigravity supports Mermaid rendering) |180| C4 diagrams, flowcharts | `mermaid-architect` | Generate **Mermaid** syntax inline directly |181182---183184**End of SKILL.md (v3.0-PDA, Antigravity-adapted)**185186---187> Source: [phamvantienkiz/agent_setup](https://github.com/phamvantienkiz/agent_setup) — distributed by [TomeVault](https://tomevault.io).188<!-- tomevault:4.0:skill_md:2026-06-16 -->
tomevault-io