User:Quiddity (WMF)/sandbox

Overview
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 of the same expectations and conventions.

Tips for writing in genres
The following table contains useful information to help you write in common genres.

Additional information

 * Technical Communication
 * Software Documentation
 * Golden Rule of Code Documentation