Remerciez-le!

Remerciez @Admin pour avoir partagé cet document gratuitement, de la manière la plus simple, en partageant sur les réseaux sociaux.

Contents of a user manual technical communication document technical writer

A user guide or user's guide also commonly known as a manual is a technical communication document 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 Most user guides contain both a written guide and the 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 hide Contents of a user manual Computer software manuals and guides References See also Contents of a user manual edit 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 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 C Where to ?nd further help and contact details A glossary and for larger documents an index Computer software manuals and guides edit User manuals and user guides for most non-trivial software applications are book-like documents with contents similar to the above list The PhotoMeister User's Manual is a good example of this type of document Some documents have a more uid structure with many internal links The Google Earth User Guide is an example of this format The term guide is often applied to a document that addresses a speci ?c aspect of a software product Some usages are Installation Guide Getting Started Guide and various How to guides An example is the Picasa Getting Started Guide In some business software applications where groups of users have access to only a sub-set of the application's full functionality a user guide may be prepared for each group An example of this approach is the Autodesk Topobase Help document which contains separate Administrator Guides User Guides and aDeveloper's Guide References edit Jump up Online Technical Writing User Guides hcexres io com Retrieved August Jump up Gary Blake and Robert W Bly The Elements of Technical Writing pg New York Macmillan Publishers ISBN Jump up PhotoMeister Professional Version PDF Paessler Software Solutions Retrieved July Jump up Google Earth User Guide Google June Retrieved August Jump up Getting Started with Picasa Getting Started Guide Google June Retrieved August Jump up Autodesk Topobase Help Autodesk Retrieved August See also edit Owner's manual Release notes Moe book C Technical writer Manual page Unix Instruction manual gaming C