User Guide
A User Guide is a technical document that can be used by a system user to operate an Interactive System.
- AKA: User Manual.
- Context:
- It can be written by a User Guide Technical Writer.
- It can range from being an Electronic User Guide to being a Physical User Guide.
- It can be a Localized User Guide.
- …
- Example(s):
- a PS5 User Manual.
- a scikit-learn User Guide Release 0.23.2, for scikit-learn.
- …
- Counter-Example(s):
- See: Technical Specification Document.
References
2020
- (Wikipedia, 2020) ⇒ https://en.wikipedia.org/wiki/User_guide Retrieved:2020-10-15.
- 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 staff, particularly in smaller companies. [1] 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, simplified diagrams. The language used is matched to the intended audience, with jargon kept to a minimum or explained thoroughly.
- 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 staff, particularly in smaller companies. [1] User guides are most commonly associated with electronic goods, computer hardware and software, although they can be written for any product.
2017
- https://www.tu-chemnitz.de/phil/english/sections/linguist/independent/kursmaterialien/TechComm/acchtml/user_guides.html
- QUOTE: A user guide is essentially a book-length document containing instructions on installing, using, or troubleshooting a hardware or software product. A user guide can be very brief - for example, only 10 or 20 pages or it can a full-length book of 200 pages or more. While this definition assumes computers, a user guide can provide operating instructions on practically anything: lawnmowers, microwave ovens, dishwashers, and so on.
The more complex the product, the greater the page count. when this happens, some elements of the user guide get split out into their own separate volumes - especially the installation procedures, troubleshooting procedures, and the commands. A user guide can even contain a brief tutorial - for example, getting users started using the product - but if there is too much tutorial, it too goes into a separate book.
Style and Format for User Guides
A user guide is a combination of many things presented in this online textbook. At its core is instruction writing; you need to be good at the writing style, headings, lists, notices, highlighting, tables, graphics commonly used in instructions. (For an overview of these elements, see the page-design chapter in this online textbook.) As a set of instructions, a user guide should use the style and format that is presented elsewhere in this online textbook:
- Headings: Use headings to mark off key contents of the information so that readers can find it quickly. See the chapter on headings for details on planning and designing headings.
- Lists: Use numbered and bulleted lists to help readers scan information quickly. See the chapter on lists for details on planning and designing lists.
- Special notices: Use special notices such as warnings, cautions, and notes to alert readers to potential problems or emphasize special points. See the chapter on notices for details on planning and designing notices.
- Instructional design: In general, use the standard design of instructions; primarily, this means task-oriented headings and sections and numbered vertical lists for actual steps that readers are to perform. See the chapter on instructions for details on planning and designing instructions.
- Instructions, and therefore user guides, also make abundant use of:
- Graphics: Show readers key components of the objects they will be working with, before and after views, and illustrations of key actions that readers must perform. See the chapter on graphics for details on planning and designing graphics.
- Tables: Provide statistical information and other such details in easy-to-access table form. In user guides, tables are particularly useful whenever reference-type information must be presented. See the chapter on tables for details on planning and designing tables.
- Highlighting: Use a consistent and standard scheme of highlighting (bold, italics, alternate fonts, color, caps, and so on). See the chapter on highlighting for details on planning and designing highlighting guidelines.
- QUOTE: A user guide is essentially a book-length document containing instructions on installing, using, or troubleshooting a hardware or software product. A user guide can be very brief - for example, only 10 or 20 pages or it can a full-length book of 200 pages or more. While this definition assumes computers, a user guide can provide operating instructions on practically anything: lawnmowers, microwave ovens, dishwashers, and so on.
2009
- ↑ Gary Blake and Robert W. Bly, The Elements of Technical Writing, pg. 143. New York: Macmillan Publishers, 1993.