Template Tuesdays

FAQ Template

The FAQ (Frequently Asked/Answered Questions) delivers content to users/customers that addresses the most common information needs on using the products or services produced by the organization. Most often delivered via a website, the FAQ uses a Question and Answer format designed to be easily findable and quickly consumed. Continue reading ...

Template Tuesdays

Release Notes Template

The Release Notes document provides the latest information about new features, enhancements to existing features, and defects fixed. The Release Notes can be as short as a few lines of text (example: an app update) or many pages, depending on a given company’s release management process. Continue reading ...

Template Tuesdays

User Guide Template

The User Guide (aka User Manual) provides the information and instructions needed to set up and use a product. A User Guide includes written and visual information (such as diagrams or screen shots) to assist the user in completing tasks associated with the product (or service), organized along functional or workflow lines. Continue reading ...

Template Tuesdays

Documentation Plan Template (Traditional)

The Traditional Documentation Plan is used to schedule and allocate resources to create and maintain technical content deliverables for a specified project or product. The plan describes the audiences, content types and output media, and provides a schedule for development and completion of deliverables. Continue reading ...

top 12 technical communication articles 5

The Storyboard: An Outline for Visual Technical Communications

As technical communicators, we’re often assigned to projects that appeal to more than one sense—words, visuals and sounds—to convey a message. A multi-media technical communications project requires not only creative skills, but organizational skills as well. We can settle on a concept, a delivery method, and come up with ideas for visuals and copy points. But, we need feedback before we invest the time producing our project, or we may find we’ve gone down the proverbial rabbit hole and missed the intended goal of the project. The storyboard provides organization and makes it easy to get feedback before production begins. Continue reading ...

Sample Documentation Plan

Submitted by Jo Baer, this documentation plan includes both a blank plan and a sample completed plan that cover cost estimating, scheduling, reviews, production, variables, and more. An excellent resource to use or adapt–in PDF format, attached. Download: Sample Documentation Plan Continue reading ...

Writing Software Requirements Specifications (SRS)

Here's the scenario: You're finishing up your latest HTML Help project...no more late nights or weekends...back to a "normal" 50-hour work week. That's when the development team lead strolls into your office and says she just got your manager's okay for you to help the development team "put together the functional requirements specification template for the next major project." Continue reading ...