This skill provides professional technical documentation writing capabilities.
Supported Document Types
1. README Documentation
- Project Introduction
- Installation Instructions
- Quick Start
- Configuration Options
- API Reference
- Contribution Guide
2. API Documentation
- Interface Description
- Request/Response Format
- Parameter Description
- Error Codes
- Usage Examples
3. User Manual
- Feature Introduction
- Operation Steps
- Frequently Asked Questions
- Troubleshooting
4. Technical Specifications
- Architecture Design
- Data Model
- Flowchart
- 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 edge cases
Usability
- Clear logical structure
- Easy to navigate
- Provide search-friendly headings
Document Templates
README Template
# 项目名称
简短描述（一句话）
## 特性
- 特性 1
- 特性 2
## 安装
\`\`\`bash
npm install xxx
\`\`\`
## 快速开始
\`\`\`javascript
// 示例代码
\`\`\`
## 配置
| 参数 | 类型 | 默认值 | 描述 |
|------|------|--------|------|
| ... | ... | ... | ... |
## 许可证
MIT
Usage Process
- Determine the document type and target audience
- Collect necessary information
- Organize content according to the template structure
- Review and optimize the expression
- Add examples and diagrams