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 ...

Developing a Departmental Style Guide

This article provides information that will help you in planning and developing a style guide. You'll find information about the purposes of a style guide and guidelines for what should (and should not) be included, whether to develop one or more style guides, and how detailed the style guide should be. 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 ...

MS Word Master Documents

This chapter from Steve Hudson’s Work in Progress on Advance Word Usage covers topics such as when to use (and when not to use) master documents, as well as “The Ten Heretical Rules of Masters,” which provides advice on how to use master documents for large or complex document production. In PDF format. Download: Microsoft-Word-masterdocs.pdf […] 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 ...