skills.rest
mvandermeulen
mvandermeulenCOMMUNITY
Explore all skills by this author →
GitHub

documentation-specialist

Generate, extract, and audit software documentation from Spring Boot and FastAPI codebases.

2|1|Updated Sep 16, 2024
Search Tags:#automation#architecture#documentation#openapi#srs#technical-writing
One-click install
npx skills add https://github.com/mvandermeulen/nvim --skill documentation-specialist-mvandermeulen
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-specialist
Source: https://github.com/mvandermeulen/nvim/tree/main/.claude/skills/document-specialist-skill
Command: npx skills add https://github.com/mvandermeulen/nvim --skill documentation-specialist-mvandermeulen

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This skill solves the common problem of poor or non-existent software documentation by automating the creation, extraction, and maintenance of technical documentation using industry standards.

Core Features & Use Cases

  • Greenfield Documentation: Generate professional SRS, PRD, and OpenAPI specifications from templates.
  • Brownfield Documentation: Reverse-engineer architecture and API docs from existing Spring Boot or FastAPI codebases.
  • Quality Control: Audit existing documentation for completeness and best practices, and convert formats between Markdown, DOCX, and PDF.

Quick Start

Use the documentation-specialist skill to create a software requirements specification for a new payment processing system.

Frequently Asked Questions about documentation-specialist

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

FAQPage Schema
How do I generate software documentation like SRS and OpenAPI specs from scratch?▼

Generate SRS, PRD, and OpenAPI specifications from scratch using industry-standard templates. The skill automates greenfield documentation creation to establish professional software docs immediately.

Can I reverse-engineer API documentation from an existing Spring Boot or FastAPI codebase?▼

Yes, you can reverse-engineer API documentation and architecture diagrams from existing Spring Boot or FastAPI codebases. The skill extracts technical specs directly from brownfield code.

How do I audit technical documentation for completeness and industry best practices?▼

Audit technical documentation for completeness and best practices through automated quality assurance. The skill evaluates existing docs to ensure they satisfy professional maintenance requirements.

What is the best way to convert software documentation between Markdown, DOCX, and PDF?▼

Convert software documentation between Markdown, DOCX, and PDF formats using the skill's automated format conversion. This ensures your technical writing remains accessible across different viewing environments.

Does this documentation automation tool require any external dependencies to run?▼

No external dependencies are required to run this documentation automation tool. The skill operates independently to generate, extract, and audit your software documentation.

When do I need to generate architecture diagrams for my software project?▼

Generate architecture diagrams when reverse-engineering brownfield codebases or mapping out new system designs. The skill automates this process for Spring Boot and FastAPI frameworks.

Related Skills

Explore More Software Engineering Skills→
nksethnkseth

spec-miner

Extract EARS-formatted specifications from existing codebases using Glob, Grep, and Read.

Community
Advanced
SpillwaveSolutionsSpillwaveSolutions
38

documentation-specialist

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

Official
Advanced
alirezarezvanialirezarezvani
763

api-documenter

Generate OpenAPI 3.0 specifications from code across multiple frameworks.

Community
Basic
akvoakvo
2

bmad-writer

Generates OpenAPI-compliant API documentation and improves READMEs for software projects.

Official
Intermediate