Goals
While the Software Design Basics card tried to make a point about writing self explanatory code, it's still essential for every application to maintain a good documentation. The README file is essential for fellow engineers to get started quickly, as it contains documentation of all major moving parts of the given app.
Ressources
- README Driven Development Show archive.org snapshot
- Writing a README for your project
- Project README examples
Exercises
- Extend the README of your MovieDB so it gives a good overview of its core features and technical aspects.
- Consider writing a card for the makandra dev deck, if you noticed anything that was missing in it during your trainee program (optional)
- Find a non-self-explanatory code segment in MovieDB and explain the implementation in a comment.
Posted by Michael Leimstädtner to makandra Curriculum (2024-06-21 13:03)