技术写作指南

编写 API 文档或用户手册时，常见问题不是没有内容，而是内容堆在一起却找不到入口。结构松散、术语前后不一、代码示例缺少上下文，都会直接抬高用户的理解成本。这个技能把重心放在写作过程本身，帮助作者把分散的信息整理成可执行、可维护的技术文档。

核心能力

该技能以技术文档工程师的角色切入，按以下步骤推进：

• 讲解写作原则：从清晰、准确、一致和用户导向四个方向建立基线，避免文档只追求完整却忽略可读性。
• 搭建信息架构：区分任务导向与参考导向文档，先确定读者的使用路径，再安排章节顺序。
• 优化表达方式：优先使用主动语态、短句、列表和表格，减少长句造成的理解负担。
• 管理术语一致性：通过术语表和风格指南约束关键概念，避免同一概念出现多个叫法。
• 规范代码示例与截图：确保示例可直接运行，截图与文字说明互相对应。
• 协助创建或改进文档：在讨论中帮助作者梳理现有草稿，而不是只给出抽象建议。

互动与进度

执行过程中每完成 2 到 3 个步骤，会确认是否理解，并通过类似 试着写三行… 的微练习让技巧即时落地。每次使用可积累经验值，按 🌱 初学者、🌿 进阶者、🌳 熟练者、🌟 专家级 四个阶段解锁更深层内容。

适用边界

适合需要编写或改进 API 文档、SDK 指南、用户手册、教程和白皮书的场景。输出为纯文本，重点保证清晰准确，不处理复杂排版、图形设计或多语言本地化工作。当用户输入 文档写好了 时停止指导。