About document-writer
document-writer is a skill for authors creating technical documentation, from project guides to API references. It covers several document types and emphasizes clarity, completeness, and navigability.
Key features
- 01Write READMEs, API docs, and user manuals
- 02Organize technical specifications and architecture notes
- 03Structure documents for target readers
- 04Include examples and check edge cases
- 05Improve headings and navigation
Use cases
- 01Create project READMEs and quick-start guides
- 02Document API parameters, responses, and error codes
- 03Prepare user guides and troubleshooting instructions
- 04Record architecture, data models, and processes
Install
Copy the command and run it in a terminal.
$
npx skills add https:/After installing, type/document-writerin Claude Code to confirm it loaded.
Details
From the project README文档编写技能
本技能提供专业的技术文档编写能力。
支持的文档类型
1. README 文档
- 项目简介
- 安装说明
- 快速开始
- 配置选项
- API 参考
- 贡献指南
2. API 文档
- 接口描述
- 请求/响应格式
- 参数说明
- 错误码
- 使用示例
3. 用户手册
- 功能介绍
- 操作步骤
- 常见问题
- 故障排除
4. 技术规范
- 架构设计
- 数据模型
- 流程图
- 接口规范
写作原则
清晰性
- 使用简洁明了的语言
- 避免歧义和模糊表达
- 提供具体示例
完整性
- 覆盖所有必要信息
- 包含先决条件
- 说明边界情况
可用性
- 逻辑结构清晰
- 易于导航
- 提供搜索友好的标题
文档模板
README 模板
# 项目名称
简短描述（一句话）
## 特性
- 特性 1
- 特性 2
## 安装
\`\`\`bash
npm install xxx
\`\`\`
## 快速开始
\`\`\`javascript
// 示例代码
\`\`\`
## 配置
| 参数 | 类型 | 默认值 | 描述 |
|------|------|--------|------|
| ... | ... | ... | ... |
## 许可证
MIT
使用流程
- 确定文档类型和目标读者
- 收集必要信息
- 按模板结构组织内容
- 审查和优化表达
- 添加示例和图表
Comments
Markdown supported