Category Archives: Technical Writing

Technical Writing: Troubleshooting Plan Template

Samantha from New Zealand asked me last week why the Troubleshooting Guide Template wasn’t for sale on the site. While this Microsoft Word template is already part of the Technical Writing Kit, I understand that not everyone wants all those documents. So, for those who want this document, what I’ve done is create a new sales page and offer it a standalone product.

Screenshot Guidelines for iOS, Android, and Technical Documents

Summary: The quality of your screenshots affects how customers perceive your products, use your software, and deal with error messages. The following guidelines can be applied to different types of technical and business documents. The final section provides screenshot guidelines for Android and iOS applications, for example, if you want to submit apps to Google […]

What is a Technical Writer?

Technical writers write technical documents that explain complex issues in simple, plain English. Technical writers – also know as Technical Authors or Information Designers – write material that supports software and hardware systems. They design, write and produce material that is delivered in print, soft-copy or as Online Help, such as that found in the […]