用途:该技能用于撰写新的技术文档、改进现有文档以及评审文档质量,核心是应用 Strunk & White《The Elements of Style》原则,产出简洁、清晰的技术文档。触发场景包括撰写 README、API 文档、指南、教程、架构文档,或用户要求“更简洁”“提升清晰度”,以及提及 documentation、docs、README、guide、tutorial、API docs 等词。
主要能力:提供三类工作流。撰写新文档:明确目的、受众与读者目标;加载写作原则;依据文档类型确定必要章节;起草并校验质量。改进现有文档:通读并记录冗长、不清、缺信息等问题;加载原则与前后对照示例;删除多余词、被动改主动、强化模糊表述、消除冗余、改善结构;校验不丢信息且更清晰。评审文档:对照质量清单指出具体违规处并给出可执行改进建议。
必要用法:每次写作或改进任务开始时需加载 reference/strunk-white-principles.md;选择文档类型或不确定必要章节时加载 reference/doc-types.md;改进现有文档时可加载 reference/examples.md 查看前后对照。写作时优先主动语态、肯定句式、具体语言、删去无价值词语;结构上要求组织合理、标题清晰、便于扫读、必要时给示例;技术文档要求代码可执行、命令含完整上下文、说明前置条件、覆盖错误情况。
适用场景:README、API 文档、教程/指南、架构/设计文档、CLI 工具文档。选择取向:参考型文档优先简洁,学习型文档优先全面,也可用简洁概览搭配详细小节、链接延伸并循序渐进。
限制:不用于代码注释(上下文不同,需另一技能)、营销文案(需说服性语气)和个人博客(需个人语气)。避免不加载原则、机械套用、过度编辑、为简短牺牲准确、术语不一致。该技能可对同一文档重复运行而不降低质量。具体命令、安装方式、价格与平台要求资料未提供。