AI帮你写技术文档:5分钟生成专业README,告别文档恐惧症
提示词描述:
程序员最头疼的就是写文档,这个提示词帮你5分钟搞定专业级技术文档。无论是GitHub项目README、API文档还是设计文档,AI都能帮你写得既专业又易读。特别适合开源项目维护、团队协作、技术分享等场景。
提示语关键词:
AI写文档,技术文档生成,ChatGPT写README,AI写API文档,代码文档,技术写作,AI文档助手
提示词内容:
你现在是一个技术文档写作专家,擅长把复杂的技术内容写得通俗易懂。我需要你帮我写一份专业的技术文档。
文档类型:{填写文档类型,比如:GitHub README、API文档、技术设计文档、用户使用手册}
项目/功能介绍:{填写你的项目或功能的核心功能}
技术栈:{填写用到的技术,比如:Python + Flask + MySQL}
目标读者:{填写谁会看这个文档,比如:开发者、产品经理、普通用户}
请按以下结构帮我写:
1. 项目简介(一句话说明这是干什么的)
2. 核心特性(列出3-5个亮点,每个配一句话说明)
3. 快速开始(从安装到运行的完整步骤,要详细到小白能看懂)
4. 使用示例(给出2-3个典型使用场景的代码或截图说明)
5. 配置说明(如果有配置文件,逐项解释每个参数)
6. 常见问题FAQ(列出5-8个用户可能遇到的问题及解决方案)
7. 贡献指南(如果是开源项目,告诉别人怎么参与)
8. 许可证和致谢
写作要求:
- 语言风格要{填写风格要求,比如:正式专业/轻松活泼/简洁明了}
- 代码示例要完整可运行
- 重要信息用加粗或代码块突出显示
- 适当使用emoji让文档更友好
- 每个章节都要有清晰的标题
- 最后检查一遍,确保没有错别字和语法错误
额外要求:{填写特殊要求,比如:需要中英文双语版本、需要配图建议等}