该技能用于撰写、改进和评审技术文档,核心方法是应用 Strunk & White《Elements of Style》的写作原则,产出简洁、清晰的内容。
用途与适用场景:编写新文档(README、API 文档、指南、教程、架构文档)、改进现有文档、评审文档质量;当用户要求“更简洁”或“提升清晰度”时也可使用。不适用于代码注释、营销文案和个人博客,因为它们的语境和语气要求不同。
主要能力:提供三套工作流。编写新文档时先明确目的、受众和读者目标,加载写作原则,确定文档类型与必要章节,再起草并做质量校验。改进现有文档时先记录冗长、表述不清、信息缺失等问题,加载原则与前后对照示例,删除无用词、把被动语态改为主动、强化模糊表述、消除重复。评审文档时按质量清单逐项对照,指出具体违规处并给出改进建议。
必要用法:任务开始时应加载 reference/strunk-white-principles.md;选择文档类型或不确定必要章节时加载 reference/doc-types.md;改进文档时加载 reference/examples.md 查看前后对照模式。质量清单涵盖内容(目的明确、信息完整、无误)、写作(主动语态、肯定陈述、具体语言、简洁)、结构(组织合理、标题清晰、便于浏览)以及技术文档(代码示例可执行、命令含完整上下文、说明前置条件、覆盖错误情况)。
限制与注意事项:不要跳过原则加载;不要僵化套用指南,需按项目实际调整章节;不要过度删减而丢失对读者有用的信息;准确性优先于简洁;同一概念应统一术语。该技能可反复运行而不降低质量。文档未提供具体安装命令、价格或平台信息。