From the course: Build with AI: Developing a Code Review Assistant

Unlock this course with a free trial

Join today to access over 25,300 courses taught by industry experts.

Documentation-driven development: API contract definition

Documentation-driven development: API contract definition

From the course: Build with AI: Developing a Code Review Assistant

Start my 1-month free trial Buy for my team

Documentation-driven development: API contract definition

“

- [Instructor] There is a particular strategy that you can follow when you want to build something with large language models, with AI tooling, in my case, something that I recommend to provide guidance, to provide accurate, you know, details of what you want to build is to work on your documentation. I have here a repository or actually a directory that only has a single file. This is just a README.md, there's nothing in here except this README file. And what I've done is, well, I've taken the time to go through some of the details on how and what I want to build. In this case, as you know, we're building a GitHub Action. This is a review bot that is going to provide us with very good feedback when we do a pull request. So I give some details. Now this documentation is not necessarily, and we can adapt it later, it's not necessarily for the end user. This would be for the large language model, for the AI tooling, whatever it is that we end up choosing. So we can use this as a…

Contents