https://eugeneyan.com/writing/writing-docs-why-what-how/
utterances-bot opened this issue · comments
How to Write Better with The Why, What, How Framework
Three documents I write (one-pager, design doc, after-action review) and how I structure them.
Thanks, writing docs is expensive, yet cheaper than meeting.
What easy to use collaborative tools do you use to write the one-pager, design doc, after-action review, and even this website?
For documents, basic google docs and the ability to comment works well. For this site, there aren't any collaborative tools involved. That said, it's built on Jekyll.
Thanks, writing docs is expensive, yet cheaper than rewriting code.
s/Difference audiences/Different audiences/
great article for writing docuemnts! but it is a little hard to understand for English beginners like me even with the help of google translate 🤣
On After Action Reviews:
I use these to reflect after shipping a project
Would you mind expanding on this a bit please? I see you've given an example for an incident, and I can sort-of see how you would convert this to a post launch reflection. Nonetheless celebrating a success is not quite the equal-but-opposite of an incident review, so I'd love to know if there are any items you generally include in one of these documents.
@oscar-barlow: An example is a launch announcement where we share:
- What was launched?
- What is the customer problem solved?
- May include screenshots of the CX
- Success metrics, usually from an AB test
- What's next?
It may also include as appendix with:
- Who made it possible?
- What tech capabilities are available for other teams?
Great prompts for reflection, thanks. I can also see how it gives the process consistency, as you define your success metrics up front.