skills.rest
warpcode
warpcodeCOMMUNITY
Explore all skills by this author →
GitHub

documentation-writer

Generate, improve, and validate documentation across code comments, READMEs, and API specs.

2|2|Updated Apr 7, 2013
Search Tags:#documentation#OpenAPI#CHANGELOG#docblocks#READMEs
One-click install
npx skills add https://github.com/warpcode/dotfiles --skill documentation-writer-warpcode
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-writer
Source: https://github.com/warpcode/dotfiles/tree/main/generic/.config/opencode/skills/documentation-writer
Command: npx skills add https://github.com/warpcode/dotfiles --skill documentation-writer-warpcode

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Creates, improves, and validates documentation across code comments, docblocks, READMEs, and API docs, with an emphasis on explaining the "why" behind decisions.

Core Features & Use Cases

  • Generate and refine docblocks, READMEs, OpenAPI specs, and CHANGELOGs.
  • Load targeted references (api-documenter, changelog generator, docblock writer, readme writer) as needed.
  • Ensure consistency, clarity, and justification for architectural decisions.

Quick Start

Prompt: "Add API documentation for the user endpoint with OpenAPI."

Frequently Asked Questions about documentation-writer

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

FAQPage Schema
How do I generate docblocks and API documentation for my codebase?▼

Generate docblocks by providing code files or API endpoints; the Skill produces language-appropriate documentation (PHPDoc, JSDoc, Javadoc, Python docstrings) with explanations, examples, and edge cases inserted above declarations while preserving code semantics.

Can I create OpenAPI specs and validate API documentation?▼

Yes. The Skill generates and refines OpenAPI/Swagger specifications for API endpoints, ensuring consistency, clarity, and completeness before finalizing, with validation against your codebase structure.

What's the best way to document READMEs and CHANGELOGs?▼

Load the README writer and changelog generator references to create clear, rationale-first documentation; the Skill generates markdown files that explain architectural decisions and justify changes across project versions.

Does this work with multiple programming languages?▼

Yes. The Skill applies to diverse codebases including PHP, Python, JavaScript, Java, and others, automatically selecting the correct docblock format and documentation style for each language.

Can I improve existing documentation and add missing docstrings?▼

Yes. The Skill enhances existing docblocks with stronger rationale, adds missing documentation to public classes and methods, and ensures completeness and clarity across all targeted files.

How do I ensure documentation explains the 'why' behind design decisions?▼

The Skill emphasizes rationale-first documentation by extracting and articulating the reasoning behind architectural decisions in comments, docblocks, and README sections, making implicit logic explicit.

Related Skills

Explore More Content & Communication Skills→
CaptainPhantasyCaptainPhantasy

interface-generator

Extract interfaces from concrete types by analyzing exported method signatures.

Community
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
hatch3rhatch3r
26

hatch3r-api-spec

Generate and validate OpenAPI 3.1 specifications from codebases with oasdiff CI gates.

Official
Advanced
Coffelix2023Coffelix2023
1

code-documenter

Generate inline code documentation, API specifications, and developer guides.

Community
Intermediate