Provide technical documentation

17 prompts that make you practise provide technical documentation rather than read about it — rehearse it against someone who does not fold, get told what you actually did wrong, and carry it into a situation you did not learn it in. 36 careers need this one, and it is the part of the work no software does for you. Everything here is built on 4 named sources, and on the 3 places those sources disagree.

17blueprints
36careers need it
4named sources
3real disagreements
Open it in the interactive atlas →

The blueprints

Each one is a different way in — open it up, go deeper, then carry it somewhere new.

Open it up First contact — what the skill even is, and where you already do it.

Definition stress-test

+
Define 'technical documentation' for a network-support team in a way that cleanly separates it from 'training…
drillrehearse against a counterparty who does not let you win easily
Define 'technical documentation' for a network-support team in a way that cleanly separates it from 'training materials' and 'inline code comments.' Use the Audience-Task-Context framework in your definition and give three specific examples of artifacts that belong in docs vs training vs comments for a Cisco router replacement project our team will do next month.
Grounded inAudience-Task-Context
Then sayNow take the three documentation artifacts you listed and for each give the single most important metric we'd use to judge whether it's 'good enough' for on-shift engineers during the cutover.
If it goes shallowIf answers drift into generic prose, force concreteness: 'Show me exact file names, sections, or a two-line excerpt for one artifact.'

Spectrum mapping

+
Map 'providing technical documentation' for network support onto a 1–5 mastery spectrum. For each level give…
grounded studylearn the real rules, including where the experts disagree
Map 'providing technical documentation' for network support onto a 1–5 mastery spectrum. For each level give 3 observable behaviors, one measurable artifact example, and one quick test a team lead could run in 10 minutes to detect that level on our Confluence repo.
Grounded inAudience-Task-ContextSingle Source of Truth / Source Control for DocsMinimal, Reproducible Example (MRE)
Then sayPick someone at our current team's typical output (I describe: terse CLI snippets, sparse checklists). Tell me which level they are and three prioritized steps to move them one level up.
If it goes shallowIf levels are vague, force metrics: 'Give one measurable metric per level (e.g., time to follow a checklist, number of ambiguous steps per page).'

First-principles reduction

+
Explain, from first principles, why a Minimal, Reproducible Example (MRE) makes troubleshooting docs more…
grounded studylearn the real rules, including where the experts disagree
Explain, from first principles, why a Minimal, Reproducible Example (MRE) makes troubleshooting docs more effective for network support. Tie the explanation to cognitive load theory or similar psychological mechanisms and give one short experimental test I could run in our team to validate the claim (50–90 words).
Grounded inMinimal, Reproducible Example (MRE)
Then saySuggest what success threshold (e.g., 20% faster median time-to-resolution) would justify rolling MREs into our runbook standards.
If it goes shallowIf explanation stays superficial, push for a named cognitive concept (e.g., intrinsic/extraneous load) and how MREs alter each.
Go deeper The real mechanics, including the parts that feel counter-intuitive.

Anti-pattern

+
Describe an anti-pattern for a network-support specialist who believes they 'write good docs' but actually…
drillrehearse against a counterparty who does not let you win easily
Describe an anti-pattern for a network-support specialist who believes they 'write good docs' but actually cause costly outages. Use the SBI adapted for docs (Situation-Behavior-Impact) to structure one extended example about VLAN change procedures and list five tangible tells that reveal this anti-pattern on our Confluence page.
Grounded inSBI adapted for docs (Situation-Behavior-Impact)
Then sayTake the top two tells and give a line-edited rewrite (2–4 sentences each) that fixes the ambiguity or omission while preserving the author's voice.
If it goes shallowIf the model lists generic tells, push for examples with exact wording to find (e.g., 'uses "verify" without specifying command output' rather than 'unclear verifications').

Scenario simulation

+
Roleplay an urgent on-call exchange: I'm the on-shift network-support specialist handling a partial outage…
drillrehearse against a counterparty who does not let you win easily
Roleplay an urgent on-call exchange: I'm the on-shift network-support specialist handling a partial outage after a config push. You play the senior engineer (difficult, pragmatic). I will paste my proposed runbook steps. Using the Minimal, Reproducible Example (MRE) idea and the Single Source of Truth principle, push back where my steps are risky, ask for missing pre-checks, and demand a specific rollback command if needed — don't be polite: call out anything that would make you refuse to run it.
Grounded inMinimal, Reproducible Example (MRE)Single Source of Truth / Source Control for Docs
Then sayI paste the runbook. Edit the first three commands for clarity and safety (one-line edits).
If it goes shallowIf the senior tone softens, send: 'Be stricter: tell me 'I will not run this' and why, using specific CLI outputs or metrics.'

Failure autopsy

+
Walk me through an autopsy of a real-feeling project where lack of maintainable docs caused a weeks-long…
grounded studylearn the real rules, including where the experts disagree
Walk me through an autopsy of a real-feeling project where lack of maintainable docs caused a weeks-long network rollout failure. Use SBI adapted for docs to map the timeline, identify the earliest traceable sign, and point to the single doc change that would have prevented escalation. Be specific: name the artifact (e.g., 'edge-firewall cutover checklist'), the missing line, and the immediate consequences.
Grounded inSBI adapted for docs (Situation-Behavior-Impact)Single Source of Truth / Source Control for Docs
Then sayTranslate that one-sentence doc fix into a two-step checklist entry we could add to our repo and an automated doc test to catch regressions.
If it goes shallowIf the autopsy is too general, ask: 'Show me the exact line the cutover engineer would have searched for and not found.'

Context shift

+
I maintain network docs for a mid-size enterprise on-prem stack. Roleplay three short memos (startup, global…
conversationa longer back-and-forth, not a single answer
I maintain network docs for a mid-size enterprise on-prem stack. Roleplay three short memos (startup, global enterprise, remote-async team) explaining how I'd change the 'router failover troubleshooting' doc. Use Audience-Task-Context and SBI adapted for docs explicitly; for each memo list exactly which sections you'd add/remove and why (focus on SLAs, tooling, and expected reader interruption levels).
Grounded inAudience-Task-ContextSBI adapted for docsResilient Documentation and Documentation-Driven Development
Then sayPick the remote-async memo and convert its suggested edits into a 10-line checklist that an on-call engineer can use before waking teammates.
If it goes shallowIf responses are generic, demand concrete constraints (SLA minutes, team size, primary tooling like ServiceNow or PagerDuty) and insist on SBI scenarios with real commands or outputs.

Translation exercise

+
I just wrote this Slack reply to a junior tech, defending a terse runbook: "It's in the repo. Read the README…
conversationa longer back-and-forth, not a single answer
I just wrote this Slack reply to a junior tech, defending a terse runbook: "It's in the repo. Read the README and the script comments. If it breaks, revert." Rewrite that message to demonstrate strong Audience-Task-Context framing and use the SBI adapted for docs to make the expectations and next steps explicit. Keep it a Slack message (50–80 words).
Grounded inAudience-Task-ContextSBI adapted for docs
Then sayNow show two shorter variants: one for an on-call engineer at 2am, one for a teammate doing a scheduled change at 10am.
If it goes shallowIf the reply becomes generic, force specificity: ask for exact repo path, script name, and the common failure mode to rework the message.

Culture clash

+
At my company US ops writes runbooks as stepwise CLI commands; our Tokyo NOC prefers annotated screenshots…
conversationa longer back-and-forth, not a single answer
At my company US ops writes runbooks as stepwise CLI commands; our Tokyo NOC prefers annotated screenshots and flows. How can we reconcile these styles so Japanese shift engineers and US field techs both succeed? Use Audience-Task-Context and Single Source of Truth / Source Control for Docs to propose an explicit doc structure and a concrete workflow for edits across cultures (70–90 words).
Grounded inAudience-Task-ContextSingle Source of Truth / Source Control for Docs
Then sayGive a file-template (front-matter fields) that enforces Audience, Task, Context, and 'preferred format' flags for UI vs CLI.
If it goes shallowIf answer stays high-level, ask for exact filenames, branch names, and PR labels that enforce the workflow.

Counterfactual

+
Look at the 2018 major outage where a misapplied config rollback caused regional network split (summarized:…
diagnosticdescribe what went wrong; get the likely causes ranked
Look at the 2018 major outage where a misapplied config rollback caused regional network split (summarized: engineer followed an outdated, fragmented doc and performed an unsafe revert). Argue specifically how applying Single Source of Truth / Source Control for Docs plus an SBI-style troubleshooting template would likely have prevented that rollback. Be concrete about what lines in the doc would change and what the emergency workflow would have been (80–110 words).
Grounded inSingle Source of Truth / Source Control for DocsSBI adapted for docs
Then sayDraft the exact SBI-style checklist lines that an on-call must read before executing a rollback.
If it goes shallowIf the argument is vague, demand the exact doc snippet (1–3 lines) that would've stopped the action.

Feedback rehearsal

+
Last Thursday I handed on-call notes to a junior tech who then escalated a routine switch reboot as a…
conversationa longer back-and-forth, not a single answer
Last Thursday I handed on-call notes to a junior tech who then escalated a routine switch reboot as a 'network outage' to the manager. Using the Audience-Task-Context framework and SBI adapted for docs, coach me on how my written handoff should have shaped their response — show the exact phrases I should have written and a 2-sentence postmortem I could send the manager.
Grounded inAudience-Task-ContextSBI adapted for docs
Then sayNow show how I should have phrased a one-line Slack alert for urgency without triggering escalation.
If it goes shallowIf answers stay abstract, ask: 'Convert this into the exact text I'd paste into the ticket body and the Slack alert.'

Junior-to-senior delta

+
I document routine router configs. Show me examples (junior, senior, manager) of an 'interface config' doc…
conversationa longer back-and-forth, not a single answer
I document routine router configs. Show me examples (junior, senior, manager) of an 'interface config' doc for a VLAN trunk using Audience-Task-Context and an MRE. Highlight the differences in scope, assumptions, and maintenance notes.
Grounded inAudience-Task-ContextMinimal, Reproducible Example (MRE)Single Source of Truth / Source Control for Docs
Then sayWhich exact lines would I add to the senior doc to prevent future drift (linking to Single Source of Truth practices)?
If it goes shallowIf responses stay generic, demand concrete file names, section headers, and example commands.

Conflict pairing

+
Simulate a 6-turn disagreement between a network engineer who insists docs must prioritize 'complete runbook…
conversationa longer back-and-forth, not a single answer
Simulate a 6-turn disagreement between a network engineer who insists docs must prioritize 'complete runbook steps' and a docs advocate who insists on 'audience-focused MREs and living docs' (use Audience-Task-Context and Single Source of Truth). Make each side realistic, name the one tacit sign they'd notice in each other's work, and end with your adjudication and one action item I should push for.
Grounded inAudience-Task-ContextSingle Source of Truth / Source Control for DocsMinimal, Reproducible Example (MRE)
Then sayNow rewrite the engineer's preferred runbook intro so it meets the docs advocate's bar without losing necessary completeness.
If it goes shallowIf dialogue becomes straw-manning, ask: 'Name one reasonable concession each side legitimately makes and show it.'
Test it elsewhere Carry it into a situation it was not learned in.

Trade-off probe

+
I'm a network support specialist deciding whether to expand our troubleshooting docs from a single-page…
conversationa longer back-and-forth, not a single answer
I'm a network support specialist deciding whether to expand our troubleshooting docs from a single-page runbook to an exhaustive 40-page playbook. Use the Audience-Task-Context framework explicitly. Give me a conversation: argue for 'keep it minimal' and then for 'make it exhaustive' as opposing team leads (3-4 points each with trade-offs tied to on-call time, onboarding speed, and drift). Then tell me which side I'd likely need given a team of six, 60% junior hires, 20% on-call load, and three concurrent vendor platforms.
Grounded inAudience-Task-ContextSingle Source of Truth / Source Control for Docs
Then sayNow assume we must pick a hybrid: propose exactly which sections become 'minimal canonical' in the single source of truth and which become 'appendix/external artifacts'. Include rules for when to expand vs prune.
If it goes shallowIf answers stay abstract, ask: 'Show me the precise on-call scenario (incident timeline, actors, command outputs) that each approach helps or hurts.'

Devil's advocate

+
Argue that 'audience-focused, example-rich docs' are overrated for network support specialists who mainly…
referencea plain fact, asked directly
Argue that 'audience-focused, example-rich docs' are overrated for network support specialists who mainly need quick checklists. Then immediately rebut your own argument and land on a pragmatic middle path: what specific hybrid doc format and maintenance rule should our team adopt? Keep it actionable (70–100 words).
Grounded inAudience-Task-ContextMinimal, Reproducible Example (MRE)Single Source of Truth / Source Control for Docs
Then saySpecify the review cadence (e.g., quarterly) and the PR label rules that ensure examples are updated when checklist changes occur.
If it goes shallowIf it stays theoretical, insist on concrete file-naming and review automation (e.g., CI job requiring 'Last Verified' date).

Teaching test

+
Design a 30-minute workshop to teach 'writing troubleshooting docs' to our network support team. Use…
conversationa longer back-and-forth, not a single answer
Design a 30-minute workshop to teach 'writing troubleshooting docs' to our network support team. Use Audience-Task-Context and SBI adapted for docs; include a 10-minute hands-on exercise (with deliverable) and one discussion question that forces the team to choose between completeness and brevity.
Grounded inAudience-Task-ContextSBI adapted for docsMinimal, Reproducible Example (MRE)
Then sayGive the scoring rubric (3 criteria, with 0–3 points each) for the exercise deliverable.
If it goes shallowIf the workshop is fluffy, request exact prompts and time limits for the exercise participants.

Retrospective lens

+
Give me 5 specific post-meeting questions I can ask myself after any troubleshooting or handoff meeting to…
drillrehearse against a counterparty who does not let you win easily
Give me 5 specific post-meeting questions I can ask myself after any troubleshooting or handoff meeting to judge how well I applied Audience-Task-Context, SBI adapted for docs, and Single Source of Truth principles.
Grounded inAudience-Task-ContextSBI adapted for docsSingle Source of Truth / Source Control for Docs
Then sayFor question 3, give example answers that would score 0, 1, and 2.
If it goes shallowIf questions are abstract, ask for an example concrete metric or artifact that proves compliance.

The canon behind these

Where these came from — and where the experts disagree.

The Elements of Style — William Strunk Jr. & E.B. WhiteThe Chicago Manual of Style — University of Chicago PressDocs for Developers: An Engineer’s Field Guide to Technical Writing — Molly E. Holzschlag & Others (representative of modern technical docs practice)Resilient Documentation and Documentation-Driven Development (industry practices) — various practitioners / technical-communication community (e.g., API doc best-practices)

Where they disagree

Comprehensiveness vs. Minimal, Task-Focused Content

Where they disagree

Centralized Editorial Control vs. Distributed, Docs-as-Code Contributions

Where they disagree

Narrative Explanations vs. Procedural, Steps-and-Checklists

What people get wrong

The confident version of the mistake.

Good documentation is just comprehensive: sources emphasize usefulness over raw completeness — prioritise critical tasks and clarity.Anyone who knows the system can write docs: effective doc-writing requires audience analysis, structure, and editorial discipline, not just subject-matter knowledge.Docs are a one-time deliverable: canonical guidance treats docs as living artifacts requiring maintenance and integration with development workflows.More detail always helps: excessive detail without organization or examples can overwhelm readers; curated, task-centered content is often better.
Soft-skill blueprints in the LLOS Work Atlas are built from the real books and named methods working professionals use — and deliberately from the places those experts contradict each other. Depth is not authority: use these to prepare for a hard conversation, never to replace the person you need to have it with.
Copyright © LLOS.ai · 2026 — original pedagogy, voice, and design — all rights reserved.

The rest of the map

Same library, five ways in.