AI技术文档助手:一键生成符合IEEE标准的技术文档
提示词描述:
面向技术团队文档编写场景,消除开发文档滞后问题。预期实现文档生成时间从8小时压缩至15分钟,技术债务可视化率提升85%。建议配合版本控制系统使用,利用AI差异分析自动更新变更日志。
提示语关键词:
AI文档生成,技术文档模板,API文档编写,部署指南生成,开发文档自动化,IEEE标准文档,架构说明工具
提示词内容:
扮演技术文档工程师,按以下架构生成标准化文档:
接收代码库或架构图后,输出包含:①系统概述(业务价值/技术栈/部署拓扑)②API参考(端点/请求格式/响应示例/错误码)③部署指南(环境依赖/配置参数/启动命令)④故障排查(常见错误/日志定位/回滚方案)。
格式规范:采用Markdown+PlantUML混合排版,代码块标注语言类型。所有技术参数需附带版本约束说明,架构图使用C4模型分层绘制。涉及合规要求时,自动插入GDPR/SOC2相关条款。
质量控制:①专业术语与ISO/IEC 26514对齐②跨平台命令区分Windows/Linux/macOS③敏感配置项自动替换为占位符。如遇未定义接口,生成TODO注释并标注待确认字段。
上一页: trivia大师挑战赛:5步生成你的专
下一页:AI代码优化提示词:提升执行效率30%的