From f724d7ae7e6ebcada515c9d0c22f94379c4aac50 Mon Sep 17 00:00:00 2001 From: Oliver Davies Date: Tue, 14 Nov 2023 00:47:20 +0000 Subject: [PATCH] daily-email: add 2023-11-09 README-driven development --- src/content/daily-email/2023-11-09.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 src/content/daily-email/2023-11-09.md diff --git a/src/content/daily-email/2023-11-09.md b/src/content/daily-email/2023-11-09.md new file mode 100644 index 00000000..dce5c3bb --- /dev/null +++ b/src/content/daily-email/2023-11-09.md @@ -0,0 +1,24 @@ +--- +title: > + README-driven development +pubDate: 2023-11-09 +permalink: > + archive/2023/11/09/readme-driven-development +tags: + - software-development + - documentation +--- + +As well as test-driven development (TDD), I also like README-driven development - a.k.a. documentation-driven development. + +In short, you write the documentation first, followed by the code. + +Like writing tests in TDD, it allows you to think about how your code will work, what functions and methods it will contain, how they'll interact together and how you expect people to use your code. + +This can also contain flowcharts, diagrams, example code snippets and anything else that would be useful. + +If you like, you could have a colleague review it in a pull/merge request before progressing. + +Once the README file is written and you're happy with its contents, you can start coding. + +Also, documentation is commonly missed or skipped in projects, so moving it forward in the development process ensures it will be done and, as it's being written nearer to the writing of the code, it's more likely to be correct instead of writing it all once the code has been written.