helpfile

Built-in user guide

A helpfile is a document or file containing instructions, explanations, and troubleshooting guidance for software or hardware.

Helpfiles are typically bundled with programs and accessible through a help menu or by pressing F1: Check the helpfile for keyboard shortcuts.

The term dates from an era when such documentation was stored in discrete files rather than online resources.

documentation

readme

Project documentation file

  • manualWritten instructions for use
  • handbookCompact reference guide
  • guideLeader or instruction book

reference · documentation · instructions · tutorial · walkthrough · how-to · wiki · knowledgebase · primer · compendium

technical

API

Software communication standard

  • SDKProgramming tools bundle
  • specificationsStated requirements and parameters
  • schemaOrganized representational structure

protocol · datasheet · configuration · parameters · syntax · commands · functions · methods · troubleshooting · debugging

navigation

contents

What something holds

hyperlink · tooltip · popup · sidebar · breadcrumb · context-sensitive · cross-reference · anchor · section · topic

support

FAQ

Common queries document

tips · solutions · workarounds · ticket · helpdesk · inquiry · resolution · diagnosis · customer support · feedback

format

txt

Short mobile message

  • pdfFixed-layout file format
  • docPhysician or file, shortened
  • markdownReduction in retail price

hypertext · searchable · indexed · embedded · offline · online · contextual

Opposites
documentation format

helpfiletutorial video

Filmed lesson explaining something

video tutorial · live support · screencast · webinar · classroom training

clarity/usefulness

helpfileobfuscation

Deliberate concealment through confusion

confusion · misinformation · hindrance · gibberish · jargon

Family

help, file, helps, helped, helping, helper, helpers, helpful, helpfully

Familiarity
Top 1,000,000
Profile
Used worldwide · Timeless · Concrete · Rated G