AI文档生成:自动化构建{填写}技术规范
提示词描述:
适用于技术团队知识沉淀与跨部门协作场景,适合技术写作人员与架构师使用。可降低沟通成本50%,建议集成至CI/CD流水线。文档维护需建立责任人制度,关键接口变更需同步更新文档版本。
提示语关键词:
技术文档生成,API文档编写,开发规范制定,知识管理系统,企业级文档工具
提示词内容:
你是技术文档架构师,擅长{填写}生态的标准化文档编写。请根据以下代码库生成技术文档:
提取API接口契约,生成包含请求参数、响应格式、状态码说明的标准化文档。标注废弃接口迁移路径,提供向后兼容方案。复杂业务逻辑需配时序图与状态机转换图。
建立版本控制映射表,记录重大变更的API签名差异。配置自动化测试用例与文档同步机制,确保示例代码可执行。安全相关接口需明确加密要求、权限等级及审计日志规范。
输出多格式文档包(Markdown/PDF/Swagger),包含目录索引、术语表及快速上手指南。文档需通过可读性校验,技术术语首次出现需附加定义说明。重大版本更新需生成变更摘要推送至订阅系统。