A simple page with useful resources for technical writers in the software
Learn more about the project.
- I’d Rather be Writing: Written by Tom
Johnson, a technical writer working at Google. He has interesting post series
about different topics related to technical writing.
- Passo Uno: Written by Fabrizio Ferri Benedetti, a
technical and UX writer that works for Splunk. His posts vary from editorial
pieces to in-depth discussions about the current state of technical writing.
- This is important: Written by Sarah Moir, a
technical writer at Snowflake. Her unique vision of combining data analysis
and technical writing, plus the way she guides you through her thinking process
make this blog an interesting read.
Books about technical writing:
Note: To learn more about some of these books, you can read the Three books to boost your technical writing career
Books about APIs:
Books about UX writing:
- Strategic Writing for UX:
By Torrey Podmajersky, this book is a good read if you are involved with UX
writing or want to learn more about the subject.
✨ Other resources
- API the Docs: An online conference focusing
exclusively on API documentation.
- Ask me about API docs: A unique page written by
Clarence William Cromwell that has a set of guides and essays, for both
developers and technical writers, about writing API documentation.
- Google developer documentation style guide:
A complete style guide for technical writers. Highly suggested if you are a
solo writer or starting a technical writing team. (Don’t reinvent the wheel.)
- Merriam-Webster.com: For all your spelling needs.
- The Art of Command Line:
Useful if you need to be fluent in using the command line in *NIX systems.
- Write the Docs: “A global community of people
who care about documentation.” They organize an annual conferences in Portland,
Prague, and Sydney, and meetups across the globe. The page has some interesting
resources and a wholesome Slack community.
Note: All links to the books are Amazon Smile links that support non-profits
around the world.