用途:面向技术文档编写,提供 API 文档、开发者指南和参考文档的写作模式与结构规范。
主要能力:
- 文档结构划分。快速开始(Getting Started/Quickstart)目标为 5 分钟内首次成功,前置条件前置列出,提供可直接复制粘贴的命令并展示预期输出。操作指南(Guides/How-To)面向任务,如“如何部署到生产环境”,采用编号步骤,一篇指南只讲一个任务,结尾链接相关指南。参考(Reference)要求每个函数、端点、参数都有文档,包含类型信息、默认值、约束,常见用例配代码示例,且可搜索。概念(Concepts/Explanation)解释系统为何如此工作、架构决策与理解系统的心智模型。
- 写作规则。使用现在时(如“The function returns...”而非“will return”);使用主动语态(如“Call the API”而非“The API should be called”);代码示例必须可编译可运行;为一切标注版本,说明文档适用于哪个版本。
使用方式:资料未提供具体安装命令、调用方式或工具集成说明,暂未提供。
适用场景:编写 API 文档、开发者指南、参考文档与概念说明时作为结构与文风参考。
限制:资料未说明支持的平台、收费、价格或效果,暂未提供。