document-writer

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

文档编写技能

Documentation Writing Skill

本技能提供专业的技术文档编写能力。

This skill provides professional technical documentation writing capabilities.

支持的文档类型

Supported Document Types

1. README 文档

1. README Documents

项目简介
安装说明
快速开始
配置选项
API 参考
贡献指南

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

2. API 文档

2. API Documents

接口描述
请求/响应格式
参数说明
错误码
使用示例

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

3. 用户手册

3. User Manuals

功能介绍
操作步骤
常见问题
故障排除

Feature Introduction
Operation Steps
FAQs
Troubleshooting

4. 技术规范

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 模板

README Template

markdown

undefined

markdown

undefined

项目名称

Project Name

简短描述（一句话）

Short description (one sentence)

特性

Features

特性 1
特性 2

Feature 1
Feature 2

安装

Installation

```bash npm install xxx ```

bash

npm install xxx

快速开始

Quick Start

```javascript // 示例代码 ```

javascript

// Sample code

配置

Configuration

参数	类型	默认值	描述
...	...	...	...

Parameter	Type	Default Value	Description
...	...	...	...

许可证

License

MIT

undefined

MIT

undefined

使用流程

Usage Process

确定文档类型和目标读者
收集必要信息
按模板结构组织内容
审查和优化表达
添加示例和图表

Determine the document type and target audience
Collect necessary information
Organize content according to the template structure
Review and optimize expressions
Add examples and diagrams