Quick Reference Guide Creator
Turn complex processes and tribal knowledge into scannable, one-page quick reference guides and cheat sheets.
Your team's 40-page process document gets ignored because nobody has time to read it. When people need an answer, they interrupt a colleague instead of checking docs. One-page quick reference guides distill the essentials into something people actually use — posted on their wall, not buried in a wiki.
Who it's for: technical writers distilling complex documentation into quick references, training managers creating job aids for new employees, team leads documenting tribal knowledge before key people leave, operations managers providing at-a-glance process guides, knowledge management specialists building scannable reference libraries
Example
"Create a quick reference guide for our incident response process" → One-page cheat sheet: decision tree for severity classification, key contacts with escalation paths, step-by-step response flow with time targets, common pitfalls to avoid, and a printable format designed for wall posting
New here? 3-minute setup guide → | Already set up? Copy the template below.
# Quick Reference Guide Creator
## Your Role
You are an expert technical writer and knowledge management specialist. Your job is to distill complex processes into scannable, one-page quick reference guides that anyone can follow.
## Core Principles
- One page maximum — ruthlessly prioritize
- Numbered steps for processes, tables for reference data
- Include the WHY behind warnings and cautions
- Test by mentally walking through each step
- Date every guide for freshness tracking
## Instructions
When asked to create a reference guide, produce:
1. **TITLE & PURPOSE** - One-line description of what this guide is for
2. **PREREQUISITES** - Checklist of what's needed before starting
3. **QUICK STEPS** - Numbered, scannable actions (main workflow)
4. **KEY COMMANDS/SHORTCUTS** - Reference table
5. **COMMON ISSUES** - Top 3-5 problems with instant solutions
6. **TIPS & BEST PRACTICES** - Pro advice from experienced users
7. **DECISION TREE** - "If X, do Y" for branching scenarios
8. **CONTACTS/RESOURCES** - Where to get help
## Output Format
Scannable markdown with checkboxes, numbered lists, emoji indicators, and tables. Designed to be printed or pinned.
## Commands
- "Create a reference guide for [process]" - Full guide
- "Condense to one page" - Ruthless compression
- "Add troubleshooting section" - Problem/solution pairs
- "Create decision tree for [scenario]" - Branching logic guide
What This Does
Transforms complex processes, lengthy documentation, or expert knowledge into concise, scannable quick reference guides. Perfect for onboarding, reducing repeated questions, and capturing tribal knowledge before experts leave.
Quick Start
Step 1: Download the Template
Click Download above to get the CLAUDE.md file.
Step 2: Gather Your Knowledge
Have existing docs, process descriptions, or expert knowledge ready to distill.
Step 3: Start Using It
claude
Say: "Create a quick reference guide for our deployment process based on these docs"
Guide Sections
| Section | Purpose |
|---|---|
| Title + Purpose | One-line "what this is for" |
| Prerequisites | What you need before starting |
| Quick Steps | Numbered, scannable actions |
| Key Commands | Shortcuts and reference table |
| Common Issues | Top problems + instant fixes |
| Decision Tree | "If X, do Y" logic flows |
| Tips | Pro advice from experienced users |
Example Output
# Deployment Quick Reference
*Deploy to production in 5 steps*
## Prerequisites
✅ VPN connected ✅ SSH keys configured ✅ Slack #deploy open
## Steps
1. Run `./deploy.sh staging` — verify in 5 min
2. Check dashboard: green = proceed, red = abort
3. Run `./deploy.sh production`
4. Monitor #alerts for 15 minutes
5. Post in #deploy: "v2.3 live ✅"
## If Something Goes Wrong
🔴 500 errors → Run `./rollback.sh` immediately
🟡 Slow responses → Check `htop` on prod-1
Tips
- Walk through the steps yourself: Missing steps surface immediately during self-testing
- Include the WHY for warnings: "Don't deploy during market hours (causes trade delays)" works better than just "don't deploy"
- Keep guides dated: So users know when info might be outdated
- Capture tribal knowledge first: Create guides for things people keep asking about
Commands
"Create a quick reference guide for [process]"
"Condense this 20-page doc into a 1-page cheat sheet"
"Add a troubleshooting section for common errors"
"Create a decision tree for handling customer escalations"
Troubleshooting
Guide is too long Say: "Strict 1-page limit — what's absolutely essential?"
Missing important steps Walk through it: "I followed the guide and got stuck at step 4 — there's a missing step"
Too technical for audience Specify: "Written for new hires with no technical background"