name: 文档系统 description: 使用渐进式披露创建面向任务的技术文档。适用于编写README、API文档、架构文档或Markdown文档。
技术文档
对于写作风格、语气和声音指导，使用 Skill(ce:writer) 并加载 工程师 角色。
核心原则
1. 渐进式披露
分层揭示信息：
| 层 | 内容 | 用户问题 |
|---|---|---|
| 1 | 一句描述 | 这是什么？ |
| 2 | 快速开始代码块 | 我如何使用它？ |
| 3 | 完整API参考 | 我的选项是什么？ |
| 4 | 架构深度探讨 | 它是如何工作的？ |
警告、破坏性变更和先决条件放在顶部。
2. 任务导向写作
<!-- 坏：功能导向 -->
## AuthService 类
AuthService 类提供认证方法...
<!-- 好：任务导向 -->
## 认证用户
要认证用户，使用凭证调用 login()：
3. 展示，而非讲述
每个概念都需要具体示例。
格式化标准
- 句子大小写标题：“Getting started” 而不是 “Getting Started”
- 最大3级标题：更深意味着拆分文档
- 始终在代码块中指定语言
- 内部链接使用相对路径
- 表格用于具有3个以上属性的结构化数据
质量检查清单
- [ ] 代码示例经过测试并可运行
- [ ] 没有占位符文本或TODO
- [ ] 匹配实际代码行为
- [ ] 可扫描而无需阅读所有内容
- [ ] 读者知道下一步该做什么
反模式
| 问题 | 修复 |
|---|---|
| 文字墙 | 用标题、项目符号、代码、表格分解 |
| 隐藏关键信息 | 警告/破坏性变更放在顶部 |
| 缺少错误文档 | 始终记录可能出错的地方 |
模板
对于README、API端点和文件组织模板，参见 references/templates.md。
相关技能
Skill(ce:writer)- 写作风格、语气和声音（加载工程师角色）Skill(ce:visualizing-with-mermaid)- 架构和流程图