用途:本技能用于指导编写清晰、可操作、以开发者为中心的开发者文档,适用于创建新文档页(教程、API 参考等)及改进现有内容。
主要能力:提供页面类型划分与结构模式。教程按“你将做什么→前置条件→步骤→验证→下一步”;API 参考按“简介→参数表→响应→错误→示例”;概念/指南按“问题→方案→何时使用→示例→权衡”;概览页按“价值主张→功能卡片→入门链接”。同时给出写作风格规范:直陈、自信、对话式;首句点明用途,句子控制在 25 词内,一段一个想法;术语先给上下文再命名,缩写首次使用需展开。格式方面规定提示框用法(Note 用于上下文与交叉引用,Tip 用于最佳实践,Warning 用于风险与破坏性变更)、代码块需标注语言并按 Shell→Python→TypeScript→Java 排序、表格左对齐且单元格简洁。
写法要点:“首屏规则”要求第一屏回答“这是什么、为什么重要”;示例需先引入概念再展示代码并解释关键部分;可提供前后对比示例。
限制与常见错误:避免大段文字先于代码、前置条件含糊、缺少下一步导航、使用营销语言、隐藏限制。参考文件包括 style-guide.md、templates.md、formatting.md、patterns.md、components.md,具体内容资料未提供完整细节。