用途:撰写或修订开发者工具的采用与集成指南,覆盖 SDK、库、CLI、框架或 API 平台,让开发者从零到可用的集成,并进一步完成正确的生产集成。
主要能力:覆盖 Diataxis 四象限(教程、操作指南、解释、参考),强调以开发者目标而非 API 符号组织内容;提供信息架构、快速上手、核心概念、集成配方、端到端教程、最佳实践、故障排查、API 参考指针、版本与迁移等章节的写作方法;也支持对既有指南做增量修订。
使用方式:先由开发者指南模板工具提供章节结构,再读取上游文档(feature-spec、api-reference、PRD 等),以 feature-spec 的能力和 api-reference 的端点驱动覆盖,所有配方与代码示例须可追溯到真实上游能力,不得虚构端点或代码路径。可用深度研究能力对齐成熟 DX 文档实践与质量准则。
适用场景:编写或修订开发者工具的入门、核心概念、集成配方、端到端教程、最佳实践与故障排查;工具版本变更、能力弃用或更名时修订既有指南。
限制:不用于编写逐端点或逐符号的完整 API 参考目录,不用于非技术终端用户手册,不用于内部工程文档(api-spec、架构文档、数据模型),也不用于评审或评分已完成指南。缺少上游文档时应将缺口标为显式假设,不得编造能力、端点或代码路径;若某集成场景无法研究或合理假设为可运行配方,应作为阻塞项上报。具体安装命令、参数、错误形态等资料未提供。