Rain Lag

The Analog Debugging Cabinet of Field Guides: Pocket-Sized Manuals for Modern Incidents

How to design pocket-sized, paper-based debugging field guides—scanalog-style manuals that mirror your tools, follow proven practices, and evolve alongside your codebase to support real-world production incidents.

Introduction

Most teams obsess over dashboards, tracing systems, and log aggregation, yet during real incidents engineers still ask the same question: “Where do I start?”

This is where an analog debugging cabinet comes in—an organized set of pocket-sized, paper field guides for every tricky class, service, and script in your system. These guides don’t compete with your tools; they complement them. They turn tacit knowledge into repeatable, scannable, scanalog workflows: flip, follow, fix.

In this post, we’ll explore how to design these paper runbooks so that they:

  • Let you directly manipulate parameters and see immediate effects.
  • Mirror your tools’ automated diagnostics as checklists and flowcharts.
  • Embed seasoned debugging wisdom (think John Robbins–style practices).
  • Live in version control and evolve with your code.
  • Work like incident-response playbooks, not coffee-table documentation.

Why Analog Debugging Still Matters

Paper field guides feel quaint in a world of IDEs and observability platforms, but they solve a real problem: cognitive overload during stress.

During a production incident, you don’t want to:

  • Dig through a wiki.
  • Skim 30-page architecture docs.
  • Reconstruct heuristics from tribal knowledge.

You want constrained, ordered, tested steps. That’s what analog debugging guides provide:

  • Low friction: Grab the guide, open to the relevant section, follow the flow.
  • Low ambiguity: Clear decision trees instead of “it depends”.
  • Low cognitive cost: Only what’s needed for this class, this service, this script.

You don’t need them often—but when you do, they can be the difference between a 10‑minute and a 2‑hour incident.


Scanalog Debugging: Hands-On, Parameter-First Guides

“Scanalog” thinking means designing paper artifacts that drive direct interaction with your system:

Flip a page → change a parameter → run a command → observe a result.

Instead of abstract descriptions, your field guides should:

  • Start from a real entry point: a failing endpoint, a misbehaving batch job, a specific error code.
  • Provide parameter-based experiments: what to tweak, how to tweak it, and what to watch.
  • Offer expected outcomes: “If X improves, you’re in scenario A; if not, continue to B.”

Example: Field Guide for a Payment Service

A pocket guide for PaymentService might include:

  • Symptom: High latency on POST /payments.
  • Step 1 – Confirm:
    • Run: curl -w "time_total: %{time_total}\n" -X POST ... with a small payload.
    • Expected: < 300 ms.
    • If > 300 ms, continue; if not, see “Intermittent Latency” section.
  • Step 2 – Parameter Experiment:
    • Toggle feature flag PAYMENT_RETRY_STRATEGY from EXPONENTIAL to FIXED in staging.
    • Rerun load test: k6 run payment-latency.js.
    • Observe: Does p95 drop noticeably? If yes, investigate retry storm.

Every step ties directly to things you can do now—not abstract speculation about what “might” be wrong.


Turning Automated Diagnostics into Paper Workflows

Many tools (APM, cloud consoles, CI systems) already perform some automated diagnosis. Your analog guides should mirror these diagnostic paths as:

  • Checklists – ordered actions you tick off.
  • Flowcharts – simple decision trees for branching scenarios.

Start from Your Tools’ UI

For each tricky component, ask:

“If I open our primary observability tool, what’s the ideal click path for debugging this?”

Maybe it’s:

  1. Go to Service Map → PaymentService.
  2. Click Traces → Filter by latency > 1s.
  3. Inspect SQL spans.
  4. Check error rate for DBTimeoutException.

Turn that into a paper flowchart:

  • Node 1: “Open APM → select PaymentService.”
  • Node 2: “Traces latency > 1s?” → Yes/No.
  • Node 3: “Top 3 spans by duration?”
  • Branch: Database vs. external API vs. internal call.

Even better, align the wording with the tool’s exact labels to minimize translation in the engineer’s brain.

Checklists that Mirror Health Checks

If a script or service has built-in health checks, reflect them as a pre-flight or post-fix checklist:

  • GET /health returns HTTP 200.
  • Database connection pool usage < 80%.
  • Message queue lag < 1,000 messages.
  • Error budget remaining > 95% for last 24h.

This allows an on-call engineer to confirm: “We’re truly back to green.”


Grounding Guides in Proven Debugging Practices

To avoid becoming theoretical or vague, field guides should borrow from established debugging experts, such as John Robbins and other practitioners who emphasize:

  • Reproducibility first: Can you reliably reproduce the issue?
  • Change isolation: What changed last? Can you roll it back or toggle it?
  • Evidence over hunches: Instrumentation, logs, and traces before guessing.
  • Binary search of possibilities: Narrow the search space step by step.

Translate these into concrete patterns in your guides:

  • A “Reproduce the Issue” section at the top, with specific commands or URLs.
  • A “Recent Change Checklist” that points to:
    • Latest deploys.
    • Recent config changes.
    • Infrastructure events.
  • A “Collect Evidence” step that lists exactly:
    • Which log queries to run.
    • Which dashboards to open.
    • Which metrics to compare.

The goal is to encode disciplined heuristics so that even a newer engineer can follow expert-level debugging behavior under pressure.


Treating Field Guides Like Code

These manuals aren’t static PDFs; they’re artifacts of the codebase and should be treated accordingly:

  • Store source files in version control (e.g., Markdown in the repo).
  • Mirror the code structure: one guide per:
    • Service (e.g., docs/runbooks/service-payment.md)
    • Critical class (e.g., docs/runbooks/class-invoice-generator.md)
    • Shared script/job (e.g., docs/runbooks/script-daily-settlement.md)
  • Review alongside code changes:
    • PR templates include: “Does this change affect any runbooks/field guides?”

Versioned, Printable Assets

Keep two forms:

  1. Source form: Markdown with sections, code blocks, and links.
  2. Printable layout: A4/Letter templates or A6 pocket cards (e.g., generated PDFs).

Use simple automation:

  • A build step that converts Markdown into standardized printable cards.
  • Tags or frontmatter (service: payment, severity: critical) to drive indexing.

Your “analog cabinet” can be literally a box or binder of these cards, labeled by service or domain, updated periodically from main.


Designing Each Pocket Guide as a Runbook

Think of each field guide as an incident-focused runbook, not a tutorial. It should optimize for time-to-diagnosis, not teaching concepts.

Key structural elements:

  1. Header Panel

    • Component name, owner team, last updated date.
    • Severity level (e.g., “Tier 1: Customer-facing revenue impact”).
  2. Triggers (When to Use This Guide)

    • Specific alerts or symptoms, for example:
      • Alert: payment_latency_p95 > 2s for 5m.
      • User-visible: “Checkout stuck on ‘Processing…’ for > 30s.”
  3. Quick Triage Decision Tree

    • A small flowchart covering the first 3–5 minutes:
      • “Is the error global or regional?”
      • “Is it only affecting one payment provider?”
  4. Procedures (Step-by-Step)

    • Numbered steps with commands and exact navigation paths.
    • Each step has expected results and next actions.
  5. Common Failure Modes

    • 3–7 scenarios with:
      • Symptom pattern.
      • Root cause indicators.
      • Recommended resolution / workaround.
  6. Escalation Paths

    • When to escalate, and to whom:
      • “If unable to identify cause in 15m, page #payments-sre.”
      • “If rollback fails, notify incident commander and consider failover.”
  7. Post-Incident Notes

    • Checklist for follow-up items:
      • “Create incident report in X.”
      • “Capture new learnings in this guide.”

Applying Incident-Response Best Practices

Good incident runbooks share certain traits: precise triggers, clear expectations, and defined boundaries. Your analog debugging guides should do the same.

Precise Triggers

Avoid vague triggers like “when the service seems slow.” Instead, write:

  • “Use this guide when any of:”
    • payment_latency_p95 > 2s for 5 minutes.
    • More than 5 customer tickets in 10 minutes with subject ‘Payment failed’.

This prevents overuse and ensures the right guide is used at the right time.

Expected Outcomes

For each branch in your flowchart or major step, note what “success” and “failure” look like:

  • “After rollback, p95 latency should return to < 300 ms within 10 minutes.”
  • “If error rate remains > 5% after mitigation, continue to Escalation section.”

This supports rapid decision-making during incidents and avoids infinite fiddling.

Escalation and Ownership

Every guide should make ownership obvious:

  • Primary owner team (with contact channel).
  • Secondary or on-call group.
  • Specific time-bound guidance: “Escalate if not resolved in 20 minutes.”

Engineers shouldn’t waste precious minutes wondering who to call.


Conclusion: Build Your Cabinet Before You Need It

An analog debugging cabinet isn’t nostalgia—it’s deliberate constraint. By investing in pocket-sized field guides that:

  • Encourage hands-on, scanalog-style debugging.
  • Mirror your tools’ automated diagnostics.
  • Encode battle-tested debugging practices.
  • Live and evolve with your codebase.
  • Follow incident-response discipline with triggers, expectations, and escalation.

…you create a safety net for your team when things go wrong.

Start small:

  1. Pick one critical service.
  2. Draft a single pocket guide with triggers, a triage flowchart, and 3 common failure modes.
  3. Store it in your repo, print it, and use it in the next game day or incident.

Over time, you’ll assemble a cabinet of analog debugging intelligence that makes your digital systems—and the humans who run them—far more resilient.

The Analog Debugging Cabinet of Field Guides: Pocket-Sized Manuals for Modern Incidents | Rain Lag