Mike's Notes
I have to write technical documentation, which I'm not great at. I have to use assistive technology, but it's just me until someone else comes along to do it better. So, where to start?
Shamelessly copying what real technical writers do. Use popular templates and frameworks. Write an outline structure and then get ChatGPT to "rewrite it in the following style ...".
Practice and more practice.
Resources
- https://www.writethedocs.org/books/
- https://www.thegooddocsproject.dev/
- https://idratherbewriting.com/learnapidoc/
- https://developers.google.com/tech-writing
- https://idratherbewriting.com/blog/what-is-diataxis-documentation-framework
References
- Reference
Repository
- Home > Ajabbi Research > Library >
- Home > Handbook >
Last Updated
18/05/2025
Technical Writing
By: Mike Peters
On a Sandy Beach: 01/08/2024
Mike is the inventor and architect of Pipi and the founder of Ajabbi.
words
No comments:
Post a Comment