User guide wikipedia User guide - Wikipedia User guide A user guide also commonly called a technical communication document or manual is intended to give assistance to people using a particular system It is usually written by a technical writer although u
User guide - Wikipedia User guide A user guide also commonly called a technical communication document or manual is intended to give assistance to people using a particular system It is usually written by a technical writer although user guides are written by programmers product or project managers or other technical sta ? particularly in smaller companies User guides are most commonly associated with electronic goods computer hardware and software although they can be written for any product Most user guides contain both a written guide and associated images In the case of computer applications it is usual to include screenshots of the human-machine interface s and hardware manuals often include clear simpli ?ed diagrams The language used is matched to the intended audience with jargon kept to a minimum or explained thoroughly Contents Contents of a user manual History Computer software manuals and guides References See also Contents of a user manual The sections of a user manual often include A cover page A title page and copyright page A preface containing details of related documents and information on how to navigate the user guide A contents page A Purpose section This should be an overview rather than detail the objective of the document An Audience section to explicitly state who is not as well as who is required to read including optionals A Scope section is crucial as it also serves as a disclaimer stating what is out-of-scope as well as what is covered A guide on how to use at least the main function of the system A troubleshooting section detailing possible errors or problems that may occur along with how to ?x them A FAQ Frequently Asked Questions Where to ?nd further help and contact details A glossary and for larger documents an index https en wikipedia org wiki User guide C History User guide - Wikipedia User guides have been found with ancient devices One example is the Antikythera Mechanism a year old Greek analogue computer that was found o ? the coast of the Greek island Antikythera in the year On the cover of this device are passages of text which describe the features and operation of the mechanism As the software industry was developing the question of how to best document software programs was undecided This was a unique problem for software developers since users often became frustrated with current help documents Some considerations for writing a user guide that developed at this time include the use of plain language length and reading di ?culty the role of printed user guides for digital programs user-centered design The user guide engraved into a model of the Antikythera Mechanism Computer software manuals and guides User manuals and user guides for most non-trivial software applications are book-like documents with contents similar to the above list They may be distributed either in print or electronically Some documents have a more uid structure with many internal links The Google Earth User Guide is an example of this format
Documents similaires
-
31
-
0
-
0
Licence et utilisation
Gratuit pour un usage personnel Attribution requise- Détails
- Publié le Sep 09, 2021
- Catégorie Administration
- Langue French
- Taille du fichier 36.7kB