documentation-builder

Original：🇨🇳 Chinese

Translated

Provides comprehensive guidance for building documentation including documentation generation, formatting, and documentation best practices. Use when the user asks about building documentation, needs to generate documentation, format documentation, or create documentation structures.

1installs

Sourcepartme-ai/full-stack-skills

Added on2026-02-07

NPX Install

npx skill4agent add partme-ai/full-stack-skills documentation-builder

SKILL.md Content (Chinese)

View Translation Comparison →

Documentation Building Skill

Overview

This skill helps you generate various technical documents, including API documents, user manuals, development guides, etc.

Keywords: Documentation Writing, API Documentation, User Manual, Development Guide, Technical Documentation, README

Core Features

1. API Documentation Generation

Generate RESTful API documentation
Describe API endpoints, parameters, and responses
Provide request and response examples
Create interactive API documentation (e.g., Swagger/OpenAPI)

2. User Manual Writing

Compose user usage guides
Create quick start tutorials
Provide frequently asked questions (FAQ)
Design operation steps and screenshots

3. Development Guide Creation

Write development environment setup guides
Create code contribution guides
Design architecture and design documents
Provide development best practices

4. README and Project Documentation

Generate project README files
Create installation and usage instructions
Write change logs (CHANGELOG)
Design project structure descriptions

Usage Guide

Documentation Writing Principles

Clarity: Documents should be clear and easy to understand, avoiding ambiguity
Completeness: Cover all important features and scenarios
Accuracy: Ensure documents are consistent with the code
Practicality: Provide usable examples
Maintainability: Documents should be easy to update and maintain

Documentation Structure

Overview: Overview of the project or feature
Quick Start: Quick start guide
Detailed Explanation: Detailed feature descriptions
API Reference: API interface documentation (if applicable)
Examples: Usage examples and code samples
FAQs: Frequently asked questions and troubleshooting

Documentation Formats

Markdown (.md)
reStructuredText (.rst)
HTML
PDF (if needed)

Output Format

Documents should include:

Document Files: Complete document content
Directory Structure: Clear chapters and directories
Code Examples: Runable code samples
Charts and Screenshots: Visual explanations (if needed)
Links and References: Links to related resources

Best Practices

Use clear headings and chapter structures
Provide usable code examples
Keep documents updated in sync with code
Use charts and screenshots for supplementary explanations
Write search-friendly documents
Consider readers of different skill levels
Regularly review and update documents