user guide
Product instruction manual
A user guide is a document explaining how to operate a product or system.
Also called a user manual or instruction manual.
User guides range from brief pamphlets accompanying appliances to extensive technical documentation for software: The user guide walks you through installation step by step.
They typically cover setup, basic operations, troubleshooting, and safety information.
Written instructions for use
- handbookCompact reference guide
- instructionsGuidance on how to proceed
- documentationWritten proof or instructions
- referenceDirecting attention elsewhere
walkthrough · how-to · FAQ · overview · specifications · glossary · appendix · index
Systematic fault diagnosis
- tipsExtras for servers
- adviceGuidance on decisions
- directionsGuidance for reaching somewhere
- explanationStatement making something clear
help desk · support · Q&A · walkthrough · step-by-step · FAQ · how-to · coaching
Alphabetical guide to contents
- table of contentsList of chapters and pages
- searchAct of seeking
- hyperlinksClickable webpage references
- bookmarksReading position indicators
sections · chapters · tabs · menu · breadcrumbs · cross-references · page numbers · sidebar
Ease of understanding text
- comprehensionMental understanding of meaning
- plain languageEasily understood communication
- conciseBriefly and clearly stated
- straightforwardClear and uncomplicated
accessible · legible · clear instructions · simplified · visual aids · diagrams · screenshots · illustrations
manual
Written instructions for use
- handbookCompact reference guide
- instructionsGuidance on how to proceed
- documentationWritten proof or instructions
reference · walkthrough · how-to · FAQ · overview · specifications · glossary · appendix · index · table of contents
troubleshooting
Systematic fault diagnosis
- tipsExtras for servers
- adviceGuidance on decisions
- directionsGuidance for reaching somewhere
explanation · help desk · support · Q&A · walkthrough · step-by-step · FAQ · how-to · coaching · onboarding
index
Alphabetical guide to contents
- table of contentsList of chapters and pages
- searchAct of seeking
- hyperlinksClickable webpage references
bookmarks · sections · chapters · tabs · menu · breadcrumbs · cross-references · page numbers · sidebar · quick reference
readability
Ease of understanding text
- comprehensionMental understanding of meaning
- plain languageEasily understood communication
- conciseBriefly and clearly stated
straightforward · accessible · legible · clear instructions · simplified · visual aids · diagrams · screenshots · illustrations · annotated
- help resourceshelp, FAQ, help center, help menu, help button
- technical manualsrepair manuals, service manual, service manuals, repair manual, installation manual
- documentsdocument, news, email, report, letter
- box contentsinstruction manual, warranty card, registration card, care instructions, parts list
- getting startedgetting started, start, begin, first steps, basics
- guideshandbook, manual, walkthrough, how-to, training manual
user guidewarranty card
Document validating repair coverage
terms and conditions · fine print · terms of service · liability waiver · corporate policy
user guidebug report
Documented software error description
customer survey · feedback form · customer complaint · error log · support ticket
guide, user, guidance, guided, guiding, guidebook, guideline, misguided, tutorial