73 lines
3 KiB
YAML
73 lines
3 KiB
YAML
uuid:
|
|
- value: 83916d2b-f03f-4add-9276-5080b66925b4
|
|
langcode:
|
|
- value: en
|
|
type:
|
|
- target_id: daily_email
|
|
target_type: node_type
|
|
target_uuid: 8bde1f2f-eef9-4f2d-ae9c-96921f8193d7
|
|
revision_timestamp:
|
|
- value: '2025-05-11T09:00:28+00:00'
|
|
revision_uid:
|
|
- target_type: user
|
|
target_uuid: b8966985-d4b2-42a7-a319-2e94ccfbb849
|
|
revision_log: { }
|
|
status:
|
|
- value: true
|
|
uid:
|
|
- target_type: user
|
|
target_uuid: b8966985-d4b2-42a7-a319-2e94ccfbb849
|
|
title:
|
|
- value: |
|
|
README-driven development
|
|
created:
|
|
- value: '2023-11-09T00:00:00+00:00'
|
|
changed:
|
|
- value: '2025-05-11T09:00:28+00:00'
|
|
promote:
|
|
- value: false
|
|
sticky:
|
|
- value: false
|
|
default_langcode:
|
|
- value: true
|
|
revision_translation_affected:
|
|
- value: true
|
|
path:
|
|
- alias: /daily/2023/11/09/readme-driven-development
|
|
langcode: en
|
|
body:
|
|
- value: |
|
|
<p>As well as test-driven development (TDD), I also like README-driven development - a.k.a. documentation-driven development.</p>
|
|
|
|
<p>In short, you write the documentation first, followed by the code.</p>
|
|
|
|
<p>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.</p>
|
|
|
|
<p>This can also contain flowcharts, diagrams, example code snippets and anything else that would be useful.</p>
|
|
|
|
<p>If you like, you could have a colleague review it in a pull/merge request before progressing.</p>
|
|
|
|
<p>Once the README file is written and you're happy with its contents, you can start coding.</p>
|
|
|
|
<p>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.</p>
|
|
|
|
|
|
format: full_html
|
|
processed: |
|
|
<p>As well as test-driven development (TDD), I also like README-driven development - a.k.a. documentation-driven development.</p>
|
|
|
|
<p>In short, you write the documentation first, followed by the code.</p>
|
|
|
|
<p>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.</p>
|
|
|
|
<p>This can also contain flowcharts, diagrams, example code snippets and anything else that would be useful.</p>
|
|
|
|
<p>If you like, you could have a colleague review it in a pull/merge request before progressing.</p>
|
|
|
|
<p>Once the README file is written and you're happy with its contents, you can start coding.</p>
|
|
|
|
<p>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.</p>
|
|
|
|
|
|
summary: null
|
|
field_daily_email_cta: { }
|