The GitHub Blog
·
基于规范的开发：在使用AI构建时将Markdown作为编程语言
💡
原文英文，约1600词，阅读约需6分钟。
📝
内容提要
AI编码助手如GitHub Copilot的工作流程简单，但可能缺乏上下文。为了解决这个问题，可以使用Markdown文件记录应用目的和设计决策，并通过Copilot编译Markdown中的代码，从而简化开发过程。使用Spec Kit工具，开发者能够更高效地管理代码和文档，保持同步。
🎯
关键要点
- AI编码助手如GitHub Copilot的工作流程简单，但可能缺乏上下文。
- 可以使用Markdown文件记录应用目的和设计决策，以帮助AI编码助手理解上下文。
- Spec Kit工具可以提高代码和文档的管理效率，保持同步。
- 通过将整个应用代码写入Markdown文件，可以让GitHub Copilot编译成实际代码，简化开发过程。
- README.md文件提供用户文档，包含安装和使用说明。
- main.md文件是应用的源代码，包含AI编码助手的规范和实现细节。
- compile.prompt.md文件用于指示AI编码助手将main.md编译成Go代码。
- 开发流程包括编辑规范文件、请求AI编码助手编译代码、运行和测试应用。
- 使用AI编码助手时，清晰描述需求是软件开发中的一大挑战。
- 可以使用AI编码助手进行代码清理和优化，提高Markdown文件的可读性。
- 经过几个月的使用，发现这种工作流程有效，并随着AI编码助手的更新而不断改进。
❓
延伸问答
如何使用Markdown文件来帮助AI编码助手理解上下文？
可以在Markdown文件中记录应用的目的和设计决策，AI编码助手会在生成代码时读取这些信息，从而更好地理解上下文。
Spec Kit工具的主要功能是什么？
Spec Kit工具提供了一种结构化的流程，帮助开发者在使用AI编码助手时实现规范驱动开发，提高代码和文档的管理效率。
在开发过程中，如何将Markdown文件中的代码编译成实际代码？
通过将整个应用代码写入Markdown文件，并使用AI编码助手编译这些文件，可以生成实际的代码，例如Go代码。
README.md文件的作用是什么？
README.md文件提供用户文档，包含安装和使用说明，帮助用户理解如何使用应用。
使用AI编码助手时，开发者面临哪些挑战？
开发者在使用AI编码助手时，常常需要清晰描述需求，这被认为是软件开发中的一大挑战。
如何保持Markdown文件和代码实现的同步？
通过将用户文档嵌入到规范文件中，任何对README.md的更新都会自动反映在main.md中，从而保持同步。
➡️
