用途:让 AI 智能体撰写高质量技术文档,覆盖 API 参考、用户指南、入门教程、更新日志、架构决策记录与 README 等格式。
主要能力与流程:先确定文档类型与读者类型(初学者、资深工程师、终端用户、决策者),相应调整词汇、深度与前提假设;再收集源代码、已有文档、设计文档、用户故事、OpenAPI/Swagger 模式、提交历史等来源材料,标注需澄清的缺口;随后按文档类型惯例设计结构——API 参考使用统一的逐端点模板,教程按步骤推进,架构文档采用上下文、决策、后果的决策记录格式;写作时使用清晰直接的语言、主动语态与短句,每节先给最重要信息,提供可完整复制运行的代码示例,术语一致并在首次出现时定义缩写;最后加入目录、锚点链接、前置与后续文档链接以及“后续步骤”,并核对代码可运行、端点路径与参数响应模式与实现一致,不留占位符或 TODO。
使用方式:向智能体提供文档类型、主题、受众、来源材料与输出格式(Markdown、reStructuredText、AsciiDoc 或 HTML)。示例提示:给出 /users 端点的 OpenAPI 规范并说明面向第三方开发者。
限制与边界:若源代码存在规范未描述的行为,应标注为“当前行为”并请工程团队确认;一份文档面向多类读者时采用分层写法;API 快速变化时标注版本或日期并声明接口可能变动;缺少来源材料时应明确列出缺失信息并索取,而非猜测;非英文文档应遵循该语言开发者社区的写作惯例。