Why this matters
Business Analysts translate complex ideas for many groups: executives, product managers, engineers, QA, legal, operations, and customers. The same information must be shaped differently to get fast decisions, accurate builds, safe releases, and smooth support. Clear audience-aware writing reduces meetings, prevents rework, and gets stakeholders aligned.
- Executive brief: secure a decision in minutes.
- Developer spec: remove ambiguity so the first build is correct.
- Support note: resolve customer issues quickly and consistently.
Concept explained simply
Good documentation answers three questions for the reader: What do I need? Why now? What do I do next?
Mental model: APFD Lens
Use APFD to adapt any document:
- A - Audience: Who reads this? What do they care about?
- P - Purpose: Decide, build, test, approve, operate, or learn?
- F - Format: Brief, spec, checklist, runbook, FAQ, or email?
- D - Detail: Depth, data, and examples matching time and risk.
Quick sanity check (APFD in 20 seconds)
- Audience: name primary role.
- Purpose: choose a verb (decide/build/test/approve/operate/learn).
- Format: pick one.
- Detail: bullets or tables; include only must-know facts.
Audience profiles at a glance
- Executives: outcomes, risk, cost, decision needed, timing.
- Product/Engineering: scope, rules, edge cases, acceptance criteria.
- QA: testable behavior, data conditions, pass/fail.
- Legal/Compliance: obligations, approvals, audit trails.
- Operations/Support: steps, signals, escalation paths.
- End Users: benefit, simple steps, screenshots, plain language.
Worked examples
Scenario: Add two-factor authentication (2FA) to customer login.
1) Executive brief (decision)
Purpose: Approve budget and timeline.
- Decision needed: Approve 2FA Phase 1 by Q3.
- Why now: Rising account takeovers; peers show 30–60% fraud reduction after 2FA.
- Impact: +0.3 NPS (security trust), -25% high-severity incidents.
- Cost: ~$65k implementation, $0.02 per SMS. (Varies by country/company; treat as rough ranges.)
- Risks & mitigations: SMS delivery issues → fallback to authenticator app; opt-in beta.
- Timeline: Pilot in 6 weeks, full rollout in 12.
2) Developer spec (build)
Purpose: Implement with no ambiguity.
- Trigger: After successful password auth, if user has 2FA enabled, show 2FA challenge.
- Methods supported: SMS code, Authenticator TOTP (RFC 6238).
- Verification window: 30 seconds; 1 attempt per 5 seconds; lock after 5 failed attempts for 15 minutes.
- Edge cases: Lost device → backup codes (10 one-time codes); time skew ±90s for TOTP.
- Acceptance criteria: Given user with 2FA enabled, when code is valid, then session token is issued and audit log records event with device_id.
- Non-functional: P99 verification latency < 300ms; audit events within 1s.
3) QA test cases (test)
- TC-001: Valid TOTP within 30s → login success; audit=SUCCESS.
- TC-002: 5 invalid codes → account locked 15 min; error message shows lock window.
- TC-003: Use backup code → login success; backup code becomes invalid.
4) Support runbook (operate)
- Verify identity: last 4 digits of phone + last login timestamp.
- If locked: unlock via Admin → Security → Unlock 2FA; note ticket ID in audit notes.
- If SMS not received: check delivery status; advise authenticator setup; resend up to 3 times.
- Escalate to Security on repeated failures (>3 tickets in 24h for same account).
- Close with macro: "2FA issue resolved. If recurring, set up authenticator app."
How to adapt your writing step-by-step
- Define the reader: One primary audience only; list secondary in a note.
- State purpose in the first line: "Decision needed by Friday" or "Spec for sprint 18".
- Choose format: Brief, spec, checklist, or runbook.
- Structure: Put must-know first; move details into collapsible sections.
- Trim and test: Remove anything that doesn’t change a decision or action.
- Preview with one reader: Ask, "What is unclear? What would you do after reading this?"
Voice and format guidelines by audience
- Executives: 5–7 bullets, one-page max, bold the decision, include risks and timing.
- Product/Engineering: numbered rules, precise terms, data shapes, acceptance criteria, examples.
- QA: preconditions, steps, expected results, negative cases.
- Legal/Compliance: cite requirement IDs, approvals needed, retention, audit fields.
- Operations/Support: step-by-step, screenshots, error codes, escalation routes.
- End Users: benefits first, 3–5 steps, no jargon, visuals, common pitfalls.
Templates you can copy
Executive Decision Brief
Decision needed: <one sentence> Context: <why now; 1–2 bullets> Options: <A/B with pros/cons> Recommendation: <1 line> Impact: <metrics or risk deltas> Cost/Timeline: <rough range; date> Risks & Mitigations: <2–3 bullets> Owner: <name>
Developer Story + Acceptance Criteria
User Story: As a <role>, I want <capability> so that <benefit>. Scope: <in / out> Business Rules: 1) ... 2) ... Data: <fields, types, limits> Edge Cases: <bullets> Acceptance Criteria: Given..., When..., Then... Non-functional: <latency, security, logging>
Support Runbook
Purpose: <what problem> Pre-checks: <verify identity / system status> Steps: 1) ... 2) ... 3) ... If fails: <branching> Escalation: <who, when> Closure note: <macro>
Common mistakes and self-check
- One-size-fits-all docs: Fix by choosing one primary audience.
- Burying the ask: Put decision or action in the first two lines.
- Undefined terms: Add a glossary or define once at the top.
- No acceptance criteria: Add Given/When/Then for each rule.
- Wall of text: Use bullets, tables, and collapsible details for background.
Self-check checklist
- Primary audience and purpose are explicit.
- Must-know comes before nice-to-know.
- Action or decision is obvious and time-bound.
- Examples cover normal and edge cases.
- Another person can follow the steps without asking you anything.
Exercises
Note: Everyone can do the exercises and the quick test. Only logged-in users have progress saved.
- Exercise 1: Rewrite one feature description for three audiences (executive, developer, support). See the exercise card below.
- Exercise 2: Draft a status/risk update for two audiences (executive vs project team). See the exercise card below.
- Checklist for your answers:
- Audience named in first line
- Purpose verb (decide/build/operate)
- Format matches purpose
- Clear action/decision and deadline
Practical projects
- Create a mini documentation set for a small feature: executive brief, one user story with acceptance criteria, and a support macro. Keep all aligned.
- Audit an existing spec. Redraft only the audience and structure; keep content the same. Measure reduced questions.
- Build a team glossary of 15 terms with examples. Use it in your next two specs.
Who this is for
- Business Analysts, Product Analysts, and Junior PMs needing faster stakeholder alignment.
- Anyone writing specs, briefs, or runbooks in cross-functional teams.
Prerequisites
- Basic understanding of your product domain.
- Ability to outline in bullets and write simple Given/When/Then criteria.
Learning path
- Practice the APFD Lens on one document per day.
- Use templates to standardize structure.
- Collect feedback from one representative reader per audience.
- Take the Quick Test to lock in concepts.
Next steps
- Apply the APFD Lens to your current sprint docs.
- Schedule a 10-minute doc review with an engineer and a support agent.
- Return and take the Quick Test to check retention.
Mini challenge
In 8 minutes, write a one-paragraph executive update and a 5-bullet developer note about the same issue: "Checkout page intermittently fails for international cards." Compare tone, detail, and action. Trim any sentence that doesn’t change a decision or next step.