Created
March 18, 2024 12:56
-
-
Save practicalli-johnny/50e164cb31b7f9c76a42c24d45212215 to your computer and use it in GitHub Desktop.
Test Driven Documentation concept - encouraging engineers to write effective documents
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Test: identify what is to be communicated | |
| - product, tools, concepts, designs, tips | |
| - identify audience | |
| Document: write the document | |
| - start with a braindump (avoid staring at a blank page) | |
| - dont worry about prose, flow or format initially | |
| - capture all the facts and useful examples | |
| Refactor: make the document effective | |
| - make the information flow from one paragraph to the next | |
| - simplify the wording | |
| - remove 'extra' words that dont add value |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment