Documentation Writing Skill

Supported Document Types

1. README Documents

• Project Overview
• Installation Instructions
• Quick Start
• Configuration Options
• API Reference
• Contribution Guidelines

2. API Documents

• Interface Description
• Request/Response Format
• Parameter Explanation
• Error Codes
• Usage Examples

3. User Manuals

• Feature Introduction
• Operation Steps
• FAQs
• Troubleshooting

4. Technical Specifications

• Architecture Design
• Data Models
• Flowcharts
• Interface Specifications

Writing Principles

Clarity

• Use concise and clear language
• Avoid ambiguity and vague expressions
• Provide specific examples

Completeness

• Cover all necessary information
• Include prerequisites
• Explain boundary cases

Usability

• Clear logical structure
• Easy to navigate
• Provide search-friendly titles

Document Templates

README Template

# Project Name

Short description (one sentence)

## Features

- Feature 1
- Feature 2

## Installation

```bash
npm install xxx

Quick Start

// Sample code

Configuration

License

## Usage Process

1. Determine the document type and target audience
2. Collect necessary information
3. Organize content according to the template structure
4. Review and optimize expressions
5. Add examples and diagrams