Cheat sheets for technical documentation

Anila Zaidi

To learn more about these cheat sheets, and technical writing in general, see the intro post Technical Writing: How To Start.

Use any one of these cheat sheets to help you write a single page of technical documentation when you're staring at a blank page.

The cheat sheets include mock content for the mock command line tool CatFactz. CatFactz generates cat facts to entertain users when they can’t take a cat nap. 🐈‍⬛ The target audience for CatFactz is developers.

• Getting started guide

• Tutorial

• How-to guide

• Explanation guide

• Reference guide

• Troubleshooting guide