Handbook Writing 是一个文档写作助手技能,来源为 steveclarke/dotfiles,定位是帮助团队编写清晰、友好、可实际操作的手册,让成员理解自己的角色、职责和工作流程,把技术文档变成人们真正愿意读、愿意用的指南。
用途
它面向的是团队手册与文档的撰写与改写,目标是让复杂流程显得平易近人、条理清楚,帮助新成员建立信心,也让老成员保持认知一致。
主要能力与写作原则
- 为人而写:使用对话式语气、清晰的过渡和自然的逻辑流。
- 先概念后细节:先介绍高层概念,再深入具体内容,先给读者“为什么”,再讲“怎么做”。
- 去除企业套话:避免“comprehensive”“robust”“seamless”“strategic”“holistic”“end-to-end”等词,改用平实直接的语言。
结构指引
- 开场:用一句清晰的目的陈述开头;在深入细节前温和地介绍关键概念;解释系统背后的“为什么”,而不只是“是什么”。
- 章节之间的衔接:在主要话题之间加入过渡句,例如“Now that you understand X, let's look at Y”;从高层到细节形成逻辑推进。
- 内容组织:把相关信息归在一起;全篇术语一致;引入新概念前先给背景;加入实际示例和真实场景。
写作技巧
- 消歧:用粗体强调关键概念,用斜体标示可能令人困惑的特定术语,清楚区分相似概念。
- 提示与注释:用带 emoji 的 blockquote 写提示,例如 > 💡 [tip content];用 blockquote 写重要说明,例如 > Note: [important information];把示例格式化为 blockquote 以形成视觉分隔。
- 示例:使用具体的真实场景而非假设情形;给示例起描述性名称,如“Invoice Approval”而不是“Example 1”,如“New Hire Onboarding”而不是“Phase 2”;展示带有真实内容的工作流步骤。
语言规范
- 语气:对话式、平易近人、直接清晰;使用“we”和“you”建立连接;避免不必要的限定和模糊措辞。
- 术语:技术术语保持一致;定义缩写和专业术语;同一概念全程用同一个词。
- 清晰度:删除冗余短语;修正别扭的句式;去掉不必要的括号和复杂标点;让括号内的信息自然融入。
质量检查清单
最终定稿前需确认:每个章节自然衔接到下一节并有清晰过渡;关键概念用粗体区分;示例使用描述性场景名称,而非“Example 1”“Phase 2”这类通用占位符;不残留企业套话;术语全程一致;文档读起来像对话而非说明书;所有标注和格式都提升可读性;开场在细节之前给出目的和高层背景;缩写和专业术语首次出现时已定义;括号信息自然流畅而不堆砌句子。
改进现有手册
在修订现有文档时,重点查找:缺少背景的章节(新人在没有背景时会在哪里困惑);通用占位符(把“Example 1”“Phase 2”换成真实场景名称);缺失的过渡(在主要章节之间加衔接句,形成逻辑流);过时的示例(更新以反映当前流程和真实用法);不一致的术语(统一为同一概念用同一个词);企业套话(删除“comprehensive”“robust”“seamless”等空洞词);薄弱的开场(确保在细节前有清晰的目的陈述和高层背景)。
适用场景
适合编写新人入职手册、角色与职责说明、团队流程文档,以及改写已有的团队手册和流程指南。
限制
资料未提供具体的安装命令、使用步骤、收费方式、价格与支持的平台信息,这些暂未提供。