用途:在编写参考文档、API 文档、参数表或技术规范时,提供信息导向的参考文档写作模式。目标读者是有经验的用户,用途是快速查证技术细节,而非学习。使用本技能时应配合 docs-style 提供核心写作原则;如需确认参考文档类型是否正确(而非教程、操作指南或解释文档),可参见 docs-style/references/diataxis-compass.md。
主要能力:提供文档结构模板(前置元数据、名称、简述、参数表、返回值表、示例、相关链接);给出写作原则:只描述不解释、文档结构镜像产品结构、以简洁取代说明、用可扫描表格代替散文、同类条目格式一致、每个示例必须可运行;涵盖参数文档(必填与可选、默认值、复杂对象类型、枚举值)、返回值与错误条件、HTTP 端点(路径、查询参数、请求头、响应)、组件 Props 与插槽等模式;还提供完成顺序的检查关卡,依次为结构、表格、可运行示例、相关链接,以及参考页检查清单(标题精确匹配、一行描述、参数类型、必填标注、默认值、返回结构、完整可运行示例、真实取值、相关页面链接、格式一致)。
使用方式:按模板编写页面;参数与返回值用列一致的表格;示例包含导入、完整可运行并给出真实取值;相关部分至少包含一个指向其他参考或指南的 Markdown 链接,或明确说明没有相关符号。
适用场景与限制:适用于 API、符号、参数表、技术规范等参考类文档。参考文档不用于教学、指导或论证;如需解释原因或引导完成任务,应链接到解释文档或操作指南,而非内嵌。关于具体命令、平台、收费或效果等事实,资料未提供。