用途:编写清晰、可维护的技术文档,面向不同读者与目的。提供多种文档类型的结构框架。
主要能力:README 覆盖项目是什么、为何存在、5 分钟内快速上手、配置与用法、贡献指南;API 文档含端点参考与请求/响应示例、认证与错误码、速率限制与分页、SDK 示例;运行手册含适用场景、前置条件与所需权限、分步流程、回滚步骤、升级路径;架构文档含背景与目标、高层设计与图示、关键决策与取舍、数据流与集成点;入职指南含环境搭建、关键系统及其连接关系、常见任务演练、问题找人指引。
使用方式:资料仅给出触发短语,如“write docs for”“document this”“create a README”“write a runbook”“onboarding guide”。具体安装与调用命令暂未提供。
适用场景:为项目补 README 与 API 文档、编写运维运行手册、梳理系统架构说明、制作新人入职指南。
原则:为读者而写,先想清楚读者是谁、需要什么;开头给出最有用的信息;用代码示例、命令和截图展示而非空谈;保持内容最新,过时文档比没有文档更糟;链接而非复制,引用其他文档。
限制:资料未说明收费、价格、模型或平台支持情况;未提供安装命令与可执行步骤,这些事实暂未提供。