user guides
Product help documents
User guides are instructional documents that explain how to use a product, software, or service.
They walk users through features, functions, and troubleshooting: The user guide covers installation and basic setup.
Also called user manuals.
The term applies broadly—from appliance booklets to comprehensive software documentation.
Compact reference guide
- manualWritten instructions for use
- instructionsGuidance on how to proceed
- proceduresSet methods for tasks
- guidelinesSuggested rules for behavior
protocols · specifications · reference · walkthrough · how-to · FAQ · troubleshooting · quick start
Process of putting in
- setupHow something is arranged
- configurationArrangement of parts
- operationProcess of working
- usageAct of employing something
customization · troubleshooting · maintenance · safety · warnings · tips · examples · scenarios
Clear explanation of complexity
- authoringProducing written content
- documentationWritten proof or instructions
- screenshotsCaptured display images
- diagramsSimplified visual representations
version control · localization · translation · editing · review · publishing · template · outline
One who lacks experience
- intermediateBetween two levels
- advancedFar along in development
- administratorPerson who manages operations
- developerOne who builds things
novice · expert · consumer · enterprise · onboarding · training · certification · self-paced
Fixed-layout document format
- printTransfer text to paper
- onlineNetwork-connected state
- interactiveAllowing mutual exchange
- videoRecorded moving imagery
illustrated · searchable · hyperlinked · downloadable · embedded · tooltip · contextual · popup
handbook
Compact reference guide
- manualWritten instructions for use
- instructionsGuidance on how to proceed
- proceduresSet methods for tasks
guidelines · protocols · specifications · reference · walkthrough · how-to · FAQ · troubleshooting · quick start · getting started
installation
Process of putting in
- setupHow something is arranged
- configurationArrangement of parts
- operationProcess of working
usage · customization · troubleshooting · maintenance · safety · warnings · tips · examples · scenarios · best practices
technical writing
Clear explanation of complexity
- authoringProducing written content
- documentationWritten proof or instructions
- screenshotsCaptured display images
diagrams · version control · localization · translation · editing · review · publishing · template · outline · drafting
beginner
One who lacks experience
- intermediateBetween two levels
- advancedFar along in development
- administratorPerson who manages operations
developer · novice · expert · consumer · enterprise · onboarding · training · certification · self-paced · instructor-led
Fixed-layout document format
- printTransfer text to paper
- onlineNetwork-connected state
- interactiveAllowing mutual exchange
video · illustrated · searchable · hyperlinked · downloadable · embedded · tooltip · contextual · popup · sidebar
- technology literaturescience fiction, cyberpunk, Neuromancer, techno-thrillers
- customer supporttickets, help desk, helpdesk, chat agent, FAQs
- how-to booksmanuals, handbooks, guides, tutorials, cookbooks
- printed materialsbrochures, magazine, leaflets, newspaper, pamphlets
- documentationmanual, manuals, readme, readme file, technical manuals
- help resourceshelp, FAQ, help center, help menu, help button
user guidestechnical specifications
Documented product parameters
source code · academic papers · raw data · tribal knowledge · maintenance manuals
guide, user, guidebook, tutorial, user guide, reference guide