Quick Reference Guides¶

Quick reference guides (QRGs) provide essential information in condensed format. They help experienced users quickly find specific information without reading through full documentation. Effective quick references prioritize density, scannability, and accuracy.

Quick Reference Purpose¶

QRGs serve users who:

Already understand basics and need specific details
Perform tasks infrequently and need reminders
Want information at a glance during work
Prefer lookup over learning

QRGs complement but do not replace comprehensive documentation.

Quick Reference Formats¶

Cheat Sheets¶

Single-page reference for commands or syntax:

# Git Quick Reference

## Basic Commands

| Command | Description |
|---------|-------------|
| `git init` | Initialize repository |
| `git clone <url>` | Clone repository |
| `git add <file>` | Stage changes |
| `git commit -m "msg"` | Commit staged changes |
| `git push` | Push to remote |
| `git pull` | Pull from remote |

## Branching

| Command | Description |
|---------|-------------|
| `git branch` | List branches |
| `git branch <name>` | Create branch |
| `git checkout <branch>` | Switch branch |
| `git merge <branch>` | Merge branch |
| `git branch -d <name>` | Delete branch |

## Undo Changes

| Command | Description |
|---------|-------------|
| `git reset <file>` | Unstage file |
| `git checkout -- <file>` | Discard changes |
| `git revert <commit>` | Revert commit |
| `git reset --hard HEAD~1` | Undo last commit |

Reference Cards¶

Portable reference for key information:

# API Quick Reference Card

## Authentication

Header: `Authorization: Bearer YOUR_API_KEY`

## Common Endpoints

| Method | Endpoint | Description |
|--------|----------|-------------|
| GET | `/users` | List users |
| POST | `/users` | Create user |
| GET | `/users/{id}` | Get user |
| PUT | `/users/{id}` | Update user |
| DELETE | `/users/{id}` | Delete user |

## Response Codes

| Code | Meaning |
|------|---------|
| 200 | Success |
| 201 | Created |
| 400 | Bad request |
| 401 | Unauthorized |
| 404 | Not found |
| 429 | Rate limited |
| 500 | Server error |

## Rate Limits

- 100 requests/minute
- Headers: `X-RateLimit-Remaining`

Keyboard Shortcuts¶

Application shortcut reference:

# Keyboard Shortcuts

## File Operations

| Windows/Linux | Mac | Action |
|---------------|-----|--------|
| Ctrl+N | Cmd+N | New file |
| Ctrl+O | Cmd+O | Open file |
| Ctrl+S | Cmd+S | Save |
| Ctrl+Shift+S | Cmd+Shift+S | Save as |
| Ctrl+W | Cmd+W | Close tab |

## Editing

| Windows/Linux | Mac | Action |
|---------------|-----|--------|
| Ctrl+Z | Cmd+Z | Undo |
| Ctrl+Y | Cmd+Shift+Z | Redo |
| Ctrl+X | Cmd+X | Cut |
| Ctrl+C | Cmd+C | Copy |
| Ctrl+V | Cmd+V | Paste |
| Ctrl+A | Cmd+A | Select all |

## Navigation

| Windows/Linux | Mac | Action |
|---------------|-----|--------|
| Ctrl+G | Cmd+G | Go to line |
| Ctrl+P | Cmd+P | Quick open |
| Ctrl+F | Cmd+F | Find |
| Ctrl+H | Cmd+H | Find & replace |

Design Principles¶

Information Density¶

Maximize useful information per area:

Use tables instead of prose
Abbreviate where clear
Eliminate unnecessary words
Use consistent formatting

Scannability¶

Enable rapid location of information:

Clear visual hierarchy
Logical grouping
Consistent layout
Bold or highlight key items

Accuracy¶

Every item must be correct:

Verify all commands and syntax
Test code snippets
Confirm keyboard shortcuts
Update when product changes

Completeness (Within Scope)¶

Include everything users need for the defined scope:

Cover common use cases
Include edge cases if critical
Reference full documentation for depth

Creating Quick References¶

Content Selection¶

Choose what to include:

Include: - Most frequently used items - Items difficult to remember - Critical syntax or parameters - Common patterns and examples

Exclude: - Rarely used features - Content requiring explanation - Anything that needs context - Self-explanatory items

Organization¶

Organize for lookup:

By function:

File Operations
Editing
Navigation
Search

By frequency:

Most Common
Occasional
Advanced

Alphabetically:

A-Z command listing

Choose organization based on how users think about the content.

Format Selection¶

Match format to use case:

Use Case	Format
Posted at desk	Printed card, poster
Carried around	Pocket card, laminated
Digital reference	Searchable web page
During work	Split-screen PDF

Writing Guidelines¶

Concise Labels¶

Use minimal words:

Too verbose:

This command initializes a new Git repository in the current directory

Concise:

Initialize repository

Consistent Format¶

Maintain patterns:

## Good (consistent)
| Command | Description |
|---------|-------------|
| `git add` | Stage changes |
| `git commit` | Commit changes |
| `git push` | Push to remote |

## Poor (inconsistent)
| Command | What it does |
|---------|--------------|
| `git add` | stages your changes |
| `commit` | This commits |
| `git push` | PUSH |

Code Formatting¶

Make code unmistakable:

Use monospace font
Include complete syntax
Show placeholders clearly: <filename>, {id}
Distinguish required vs optional: [optional]

Visual Hierarchy¶

Guide the eye:

# Main Category

## Subcategory

| Command | Description |
|---------|-------------|
| `cmd1` | Does X |
| `cmd2` | Does Y |

## Another Subcategory
...

Maintenance¶

Version Tracking¶

Track which product version the QRG covers:

# Application Quick Reference
Version 4.2 | Updated: January 2025

Update Triggers¶

Update when:

Product releases with changes
Users report errors
New important features added
Shortcuts or syntax change

Verification¶

Periodically verify:

All commands still work
Shortcuts are correct
Information is current
Layout is optimal

Distribution¶

Print Formats¶

For physical reference:

Business card size (pocket)
Letter/A4 (desk reference)
Poster (wall display)
Laminated (durability)

Digital Formats¶

For electronic use:

PDF (printable, portable)
Web page (searchable, linkable)
Mobile-optimized (phone reference)
IDE integration (in-context)

Examples by Domain¶

Programming Language¶

# Python Quick Reference

## Data Types
`int`, `float`, `str`, `bool`, `list`, `dict`, `tuple`, `set`

## Common Operations
| Operation | Syntax |
|-----------|--------|
| List comprehension | `[x for x in items]` |
| Dictionary | `{key: value}` |
| String format | `f"Hello {name}"` |
| Range | `range(start, stop, step)` |

System Administration¶

# Linux Command Reference

## File Operations
| Command | Description |
|---------|-------------|
| `ls -la` | List all files |
| `cp src dest` | Copy file |
| `mv src dest` | Move/rename |
| `rm -rf dir` | Remove directory |
| `chmod 755 file` | Change permissions |

Application¶

# Photoshop Shortcuts

## Tools
| Key | Tool |
|-----|------|
| V | Move |
| M | Marquee |
| L | Lasso |
| B | Brush |
| E | Eraser |

Summary¶

Quick reference guides provide fast access to essential information:

Maximize density while maintaining clarity
Organize for rapid lookup
Keep format consistent and scannable
Verify accuracy rigorously
Update when products change
Distribute in appropriate formats

QRGs complement comprehensive documentation by serving users who know what they need and want to find it quickly.

Next: FAQs covers frequently asked questions documentation.