This page provides some tips for designing and writing in specific types (genres) of technical documentation for software development.
A number of genres or document types are used frequently by technical documentarians to communicate information to audiences. Different genres of technical documentation often have specific features that documentarians include and audiences expect.
When you know your audience and what kind of information you would like to convey, it can be helpful to decide on a specific genre or document type before you start writing. After selecting the type of document you are creating, you may find it easier to structure the document and format your information.
What is a genre?
Genre is one way to classify the kind of writing you are doing. It can help determine the structure or form your writing will take.
Genres can usually be identified by sets of expectations and conventions. Documents written in a particular genre will typically have similar (if not the same) features -- though they may not share all the same expectations and conventions.
Tips for writing in genres
The following table contains useful information to help you write in common genres.
|TIPS AND RESOURCES
|An FAQ is a list of frequently asked questions (FAQs) and answers, often seen on technical support websites.
Walkthroughs, how-tos, and tutorials
|This genre of documentation helps guide audiences through a specific process step by step.
|Walkthoughs, how-tos and tutorials template
|A quickstart guide is a short tutorial designed to get users up and running with a software application or tool.
|Quickstart Guide Template
User guides, reference guides, and technical manuals
|A task-oriented guide that contains installation and usage instructions for the end-users of a software/product.
|A README is a plain text file that describes the directories and files in the software code. It also contains information on how to install and use the software.
An API is a set of protocols and tools that aid easy communication between different parts of a software.
|API Documentation template
|A library is a piece of code written and organized in such a way that it can be used by multiple programs that have no connection with each other.
|A troubleshooting document contains solutions for the possible issues that a user might encounter while installing, configuring or using a product/software.
|Release notes describe new features and bug fixes for software.
|In the field of technology, a white paper advocates the philosophy behind a product, software or technology.
|A Technical specification describes the standards that a software/product must meet.
|A type of website consisting of text, pictures, etc., in the form of journal entries, called posts. It is typically presented in chronologically reverse order and is updated frequently.
|The brief overview of a document.
|A document which presents the author's opinions about a particular subject.
Tickets (task, bugs, features request, etc.)
|A form (or document) used to report bugs and/or request new features.
A document proposing a topic, finding or theory that constitutes a request for presenting the topic at a conference.
A talk, workshop, poster, research paper, etc., that is presented at a conference.