documentation

= Documentation  =

Not 100% about some of this stuff. Will cut and edit it at the end.
If someone can go over it. that would be great. cheers Also needs pics.

**What is Documentation:**
====In computer hardware and software product development, documentation is the information that describes the product to its users. It consists of the product technical manuals and online manuals/information. The term is also sometimes used to mean the source information about the product contained in design documents, detailed code comments, white papers, and blackboard session notes.====

It is important to develop a user documentation to assist users with the function and operation of a solution once it has been created. The documentation process involves creating step by step instructions for users to work with the solution. This process establishes the procedures that are necessary to allow the system to run efficiently.


 * User Documentation should meet the specific needs of the user.
 * User Documentation should be written in a way that take into account the background of the intended users. There is no point in writing documentation in heavy technical detail if the user is unlikely to understand it.
 * If heavy technical words and complex terms are used, they should be provided with a glossary so that the user can look up the meaning of the word easily.


 * User documentation should:**
 * be easy to follow
 * Have clear and easy to read instructions
 * Make sure that the writing style and level of language is of the same level as the intended audience.
 * Have correct terminology
 * Have the correct sequence of steps involved to aid the user in easy following each instruction.
 * Have screen shots or diagrams to aid the user in completing each instruction.

There are two type of documentation.
 * Types of documentation:**
 * Hard copy
 * Product manual handbooks, FAQ cards,
 * Electronic
 * Onscreen user Documentation


 * Onscreen User Documentation:**
 * Onscreen User Documentation is information to provide guidance to users via communication by a device or the internet.
 * It explains how to use a product or how to perform a procedure with the product.
 * Its structure and layout should be clear and logical so that a user can easily follow the instructions.
 * Onscreen User Documentation information may be presented as text, hypertext, graphics or video. Or a combination of these.
 * Onscreen User Documentation is cheaper to produce than paper based manuals and is easier for consumers to use.

There are serveral types of Onscreen User Documentation. These include
 * User guides and instruction manuals
 * Quick start guide
 * In-house user documentatation
 * Read me files
 * Tutrials
 * Help files
 * Web support
 * Tool tips and hint boxes


 * User guides and instruction manuals:**
 * On screen User guides and instruction manuals are standard guides providing free on CD or DVD with a commercially purchased software/hardware device.
 * Purpose: to inform and instruct the user about characteristics, capabilities and functions of the hardware/software.
 * Context: Details how to start using the product, how to perform typical actions with the product.
 * Contain safety warnings and guide lines for safe operation of the product.
 * Conveniently small in size. Contains pictures.

Examples: PDF/Browser based guides.


 * Quick start guides:**
 * On screen quick start guides are provided with an application or device for first time or inexperienced users of a product
 * Purpose: Give brief, simple instructions
 * Context: Brief statements on safe usage, how to perform common task such as opening a file, saving, printing and exiting.
 * Lots of 'attention grabbing' visuals such as screen shots, pictures, diagrams, videos and even voiced instuctions to aid the user


 * In-house user documentatation:**
 * Documentations about a organizations security protocol, file naming and file storing procedures, email protocols and trouble shooting protocols.
 * May also apply to customized information products, such as a companies database, excel spreadsheets of a company.
 * Due to it is locally made (normal by someone inside the organization, network manager) it is normal stored on a intranet or local server and not on a CD or DVD.
 * Normal PDF or hypertext

Example: Like the documentation we made for the nursery SAC. where we had to make an excel spreadsheet and then write a documentation on how to use it. That is an example of in-house documentation due to it applied to a customized information product for a particular company.


 * Read Me Files:**
 * Read me files contain important information for users, such as system requirements, configuration settings for the product, troubleshooting strategies, web support addresses and details on how to access product information.
 * Normally Text files in notepad.
 * No visual support. Just plain standard text.

Examples: How to videos, ............
 * Tutorials:**
 * Tutorials consists of very detailed step by step instuctions for using the features and functions of a software program or hardware device.
 * May include text, video, pictures, diagrams, screen shots, in a PDF or hypertext or may just be a series of multimedia files.
 * The video and audio files normally 'talk to the through' the process offering detailed steps one at a time, so the user can pause and go back at any stage.

Examples: Microsoft word glossary
 * Help files:**
 * Help files provide searchable information about the features and functions of a software application or a device.
 * Help files can be extensive and extremely long and detailed.
 * They normal contain an overview of various topics, as well as detailed examples and tutorials.
 * Usually searchable by contents or an alphabetically index or by typing a question into a question field.
 * Do not contain technical information about a product. Rather a link to a site which will provide you with further details.


 * Web support:**
 * Web support is a type of on screen documentation for hardware and software products which is available directly from a manufacturers website.
 * About 99% of the time it is via hyperlink
 * Normally has FAQ and a discussion board or forum for people to talk about the product and its problems.
 * Can have latest patches or software updates

Examples: Any web support website. eg. https://support.steampowered.com/

These are also on-screen documentation as they provide content sensitive help to support the suer in understanding and using a software product.
 * Tool Tips and Hint boxes:**
 * **Tool tip:**
 * Within a software application, holding the cursor over an icon may highlight a text box with the name or function of the icon
 * **Hint box:**
 * Within a software application, clicking on a icon may open a hint graphic.