documentation-builder

Documentation Building Skill

Overview

This skill helps you generate various technical documents, including API documentation, 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 (such as Swagger/OpenAPI)

2. User Manual Writing

• Write user 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
• Create installation and usage instructions
• Write changelog (CHANGELOG)
• Design project structure documentation

Usage Guide

Documentation Writing Principles

1. Clarity: Documentation should be clear and easy to understand, avoiding ambiguity
2. Completeness: Cover all important features and scenarios
3. Accuracy: Ensure documentation is consistent with the code
4. Practicality: Provide actually usable examples
5. Maintainability: Documentation should be easy to update and maintain

Documentation Structure

• Overview: Overview of the project or feature
• Quick Start: Quick start guide
• Detailed Description: Detailed feature description
• API Reference: API interface documentation (if applicable)
• Examples: Usage examples and code examples
• Frequently Asked Questions: FAQ and troubleshooting

Documentation Formats

• Markdown（.md）
• reStructuredText（.rst）
• HTML
• PDF (if needed)

Output Format

Documentation should include:

• Documentation Files: Complete documentation content
• Table of Contents: Clear chapters and table of contents
• Code Examples: Actually runnable code examples
• Charts and Screenshots: Visual explanations (if needed)
• Links and References: Links to related resources

Best Practices

• Use clear headings and chapter structure
• Provide actually usable code examples
• Keep documentation synchronized with code updates
• Use charts and screenshots to assist explanations
• Write documentation that is easy to search
• Consider readers of different levels
• Regularly review and update documentation

Capability Boundaries

✅ Applicable Scenarios

• When you need to use the technology stack corresponding to this skill
• When the project needs to follow best practices
• When you need to quickly get started or deeply understand core concepts

⚠️ Notes

• Complex business logic needs to be adjusted according to specific scenarios
• Performance optimization needs to be evaluated based on actual data volume

❌ Inapplicable Scenarios

• Unrelated tech stacks or frameworks
• Special scenarios requiring full customization

Usage Process

Step 1: Environment Preparation

Ensure that the necessary dependencies and tools are installed in the development environment.

Step 2: Configuration Initialization

Perform basic configuration according to project requirements.

Step 3: Using Core Features

Implement the core features according to the sample code.

Step 4: Test Verification

Run tests to ensure the features work properly.

Step 5: Deployment and Launch

After development is complete, proceed with deployment and monitoring.