Examples of Common Deliverables

One of the crucial things to do as a technical writer is to specify deliverables for your project. Deliverables refer to outputs that you, as a writer, create and provide to your audience. They vary based on the project, audience, and purpose.

Here are some common deliverables:

• User manuals/Guides: Comprehensive documents that provide step-by-step instructions on how to use a product or software. They often include illustrations, screenshots, and troubleshooting tips.
• Installation Guides: Instructions on how to install and set up software, hardware, or equipment. They may include system requirements, configurations, and troubleshooting steps.
• Online Help Documentation: Interactive online guide, often in a form of a website or directly within a software application where customers can find answers to their questions and solutions to their problems. Form of user assistance. The purpose of most online help is to assist in using a software application, web application, or operating system.
• API Documentation: Documentation that explains how to use and interact with Application Programming Interfaces (APIs), including endpoints, parameters, and sample code.
• Release Notes: Documentation that highlights changes, updates, and improvements in software or product releases. It informs users about new features, bug fixes, and known issues. Release notes are distributed alongside the launch of new software or its updates. They may be accompanied by other instructions, such as setup instructions, feature descriptions, and user interface changes.
• Glossaries: Lists of technical terms and their definitions that help users understand specialized terminology used in the documentation.
• User Interface (UI) Text: Text strings (lines of text) that appear as part of software interfaces and are displayed to users. As a writer, your job is to make sure they are concise, clear, and user-friendly.
• Accessibility Documentation: Outlines how a product or documentation meets accessibility standards for use by individuals with disabilities.
• Technical Articles/Blogs: Informative articles explaining technical concepts, trends, or best practices. These can be published on blogs, websites, or other publications.

These are not all deliverables, of course, but probably the ones I would emphasize the most. Others include whitepapers, tutorials, training materials, etc.