documentation-specialist

Generate software documentation from templates and code with multi-format outputs.

38|9|Updated Nov 18, 2025
One-click install
npx skills add https://github.com/SpillwaveSolutions/document-specialist-skill --skill documentation-specialist
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-specialist
Source: https://github.com/SpillwaveSolutions/document-specialist-skill/tree/main/.
Command: npx skills add https://github.com/SpillwaveSolutions/document-specialist-skill --skill documentation-specialist

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

The Documentation Specialist accelerates the creation and maintenance of software documentation, reduces manual writing time, and minimizes token waste by using Progressive Disclosure Architecture (PDA). It supports greenfield templated docs, brownfield code-to-docs extraction, audits, format conversions, and diagram generation to keep docs accurate and up-to-date with minimal effort.

Core Features & Use Cases

  • Greenfield Documentation: generate IEEE SRS, PRD, OpenAPI specs, user manuals, tutorials, and runbooks from templates.
  • Brownfield Documentation: reverse-engineer documentation from existing codebases (e.g., Spring Boot, Pulumi).
  • Documentation Audit: review and improve existing documentation for clarity, completeness, and compliance.
  • Format Conversion & Diagrams: convert between Markdown, DOCX, PDF and generate architecture diagrams (Mermaid, PlantUML, ER).
  • On-Demand Loading: load only the necessary workflows, references, templates, and examples to minimize token usage.
  • Examples & Guidance: learn from production-quality examples to accelerate documentation work.

Quick Start

  1. Describe your documentation need, e.g., "Create an SRS for a HIPAA-compliant patient portal."
  2. The skill classifies the intent and loads the appropriate greenfield workflow and template.
  3. The skill generates the customized documentation and saves it to your docs folder.
  4. Optionally convert to PDF or add diagrams using additional skills.

Frequently Asked Questions about documentation-specialist

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate software documentation generation from code?

Automate documentation generation by describing your need (e.g., 'Create an OpenAPI spec from my Spring Boot API'), and the Skill classifies the intent, loads the appropriate template or code-analysis workflow, and generates customized documentation in Markdown, DOCX, or PDF format with minimal manual effort.

Can I reverse-engineer documentation from an existing codebase?

Yes, brownfield documentation extraction reverses the documentation from existing codebases like Spring Boot or Pulumi, automatically identifying APIs, components, and workflows to create SRS, PRD, or OpenAPI specifications without writing from scratch.

What documentation formats does code-to-docs support?

Code-to-docs supports IEEE SRS, PRD, OpenAPI specifications, SDD, user manuals, tutorials, and runbooks with outputs in Markdown, DOCX, and PDF, plus diagram generation using Mermaid and PlantUML for architecture and entity-relationship visualization.

How do I audit and improve existing documentation?

Documentation audit reviews existing docs for clarity, completeness, and compliance, then performs gap analysis and generates traceability matrices to identify missing sections, inconsistencies, and style violations for targeted improvement.

Does this work for greenfield projects needing templates?

Yes, greenfield documentation uses IEEE and industry-standard templates to generate complete SRS, PRD, and API specifications from requirements, reducing initial documentation effort while ensuring structural consistency and regulatory compliance.

What's the benefit of progressive disclosure for documentation?

Progressive Disclosure Architecture loads only necessary workflows, references, and templates on-demand, minimizing token usage and processing time while maintaining quality-assurance features like audits, gap analysis, and style guidelines.