Senior-grade Documentation
Produce a senior-level documentation ready to ship.
View full prompt
Act as a senior technical writer with 10+ years specializing in technical documentation for developers. I will give you the brief; you will deliver a ship-ready documentation.
Brief: [PASTE BRIEF HERE].
Constraints: must be specific, measurable, and grounded in technical documentation best practice. Avoid generic advice and obvious tips.
Deliver:
1. The full documentation (the actual artifact, not a description of it).
2. Three sharpening notes - what you would test or improve first.
3. One contrarian angle most technical writers miss.
Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationseniordeliverable
Critique my Documentation
Tear down an existing documentation and rebuild it stronger.
View full prompt
You are a brutal but constructive technical writer reviewing my documentation. Your job is to make it 2x better, not to be polite.
My documentation: [PASTE HERE].
Target time-to-first-success: [STATE TARGET].
Audience: developers.
Return:
- 5 specific weaknesses, each tied to time-to-first-success.
- A rewritten documentation that fixes them.
- A diff-style explanation of what changed and why.
Be blunt. Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationcritiquereview
10 variants of a Documentation
Spin 10 distinct angles for the same brief.
View full prompt
Generate 10 meaningfully different documentations from the same brief. Each variant must hit a different angle - not paraphrases.
Brief: [PASTE].
Audience: developers.
For each variant provide:
- Angle name (1-3 words).
- Hook / opening line.
- Full documentation.
- The single psychological lever it pulls (loss aversion, status, novelty, etc.).
End with your top pick and a one-line reason. Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationvariantsideation
Apply a proven technical documentation framework
Run a named technical documentation framework end-to-end on my situation.
View full prompt
Pick the single best-known technical documentation framework for this situation, name it, then walk me through applying it to my brief step by step.
My situation: [PASTE].
Goal: time-to-first-success.
Output:
1. Framework name + 1-line origin (so I can verify).
2. Each step labelled, with my inputs filled in.
3. The resulting documentation.
4. Where the framework breaks down - and what to swap in.
Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationframework
Rewrite for a different audience
Translate the same documentation for three different audiences.
View full prompt
Take my existing documentation and rewrite it cleanly for three distinct audiences. Keep the core promise; change the vocabulary, references, and emotional register.
My documentation: [PASTE].
Audiences:
A) developers (current).
B) A skeptic who has been burned before.
C) An expert peer who could spot fluff in two seconds.
For each: full rewrite + 2-line note on what shifted. Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationtranslationaudience
Documentation in 50 words
Strip a documentation to its essential 50 words.
View full prompt
Compress the strongest possible documentation into exactly 50 words. Every word must earn its place.
Brief: [PASTE].
Audience: developers.
Deliver:
- The 50-word documentation.
- The 3 words you would protect if forced to cut to 30.
- The cheap word you almost used and why you killed it.
Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationconstrainttight
Documentation optimized for discovery
Make a documentation that ranks and gets shared.
View full prompt
Produce a documentation that is optimized to be found and shared in the technical documentation space, not just to read well.
Topic: [PASTE].
Audience: developers.
Primary keyword/phrase: [PASTE].
Deliver:
- The documentation, with the primary phrase used naturally in title, opener, and one mid-point anchor.
- 5 semantic keywords you wove in (and where).
- 3 share-bait one-liners I could pull as social hooks.
Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationseodistribution
Compare-and-rank matrix
Score options against the criteria that matter.
View full prompt
Build a comparison matrix that ranks options for my technical documentation decision honestly.
Options: [LIST 3-6].
My priority: time-to-first-success.
Constraints: [PASTE].
Deliver:
1. A table - options × criteria - scored 1-5 with a one-line justification per cell.
2. The weighted winner.
3. The "wrong but obvious" pick most technical writers would default to, and why it loses.
Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationcomparisondecision
Speak as the customer persona
Hear the documentation through the audience's head.
View full prompt
Embody a precise developers persona and react to my documentation as they would, out loud.
The persona: [PASTE 3-5 traits - role, fear, current solution, last frustration].
My documentation: [PASTE].
Deliver:
- 3 internal-monologue paragraphs as the persona reading the documentation.
- The exact line where they would close the tab - and why.
- 2 edits that would make them keep reading.
Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationpersonaempathy
Edge-case enumeration
List the failure modes for a documentation before they bite.
View full prompt
Enumerate the edge cases and failure modes that could break my documentation in production / in market / in front of developers.
My documentation: [PASTE].
Context: technical documentation.
Deliver:
- 12 edge cases, ranked by likelihood × damage.
- For each: the trigger, the symptom, and the cheapest mitigation.
- The single edge case I should design around first.
Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationedge-casesrisk
Risks & mitigations
Pressure-test a plan before committing.
View full prompt
Stress-test my technical documentation plan and surface what could go wrong, with mitigations.
Plan: [PASTE].
Stakes: time-to-first-success.
Deliver:
1. 7 risks across execution, market, technical, legal, reputational.
2. For each - probability (L/M/H), impact (L/M/H), and a mitigation that costs less than the worst case.
3. The 1 risk worth accepting and the 1 risk worth killing the plan over.
Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationriskplanning
Reusable documentation template
Turn a one-off into a fill-in-the-blank template.
View full prompt
Convert a great documentation into a reusable template I can fill in repeatedly.
Reference documentation: [PASTE].
What stays fixed: the structure and rhythm.
What varies: the inputs.
Deliver:
- The template with clearly marked [VARIABLES].
- A one-line description of each variable and example values.
- 2 worked examples using different inputs.
- The 1 line I should never let a junior change.
Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationtemplatereuse
30-day ramp plan
Go from zero to shipping in 30 days.
View full prompt
Design a 30-day plan to take me from where I am now to shipping a credible documentation in technical documentation.
Starting point: [PASTE].
Time available per day: [PASTE].
End state: time-to-first-success.
Deliver:
- Week 1-4 milestones (1 sentence each).
- Daily 30-minute focus for every day, grouped by week.
- The 3 things I should NOT do during these 30 days.
- The checkpoint that proves I'm on track at day 14.
Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationplanonboarding
Diagnose from symptoms
Root-cause a technical documentation problem from the symptoms I see.
View full prompt
I am seeing symptoms in my technical documentation work. Diagnose the most likely root causes and propose tests to confirm.
Symptoms: [LIST 3-6].
What I have already ruled out: [PASTE].
Tools available: [PASTE].
Deliver:
1. 3 candidate root causes, ranked by likelihood with a 1-line reason.
2. The fastest test to disprove each.
3. The order to run those tests, and stop conditions.
Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationdiagnosisroot-cause
End-to-end workflow design
Design the documentation workflow technical writers actually run.
View full prompt
Design the end-to-end workflow a technical writer would run to produce a high-quality documentation repeatedly.
Volume target: [PASTE].
Team size: [PASTE].
Quality bar: time-to-first-success.
Deliver:
- The workflow as a numbered sequence of steps.
- For each step: input, output, owner, tool, and time-box.
- Where to insert review gates without slowing the pipeline.
- The bottleneck step and how to relieve it.
Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationworkflowops
Measurement plan & dashboard
Decide what to measure for time-to-first-success.
View full prompt
Design a measurement plan for time-to-first-success in this technical documentation context.
Goal: time-to-first-success.
Audience for the dashboard: [PASTE].
Available data sources: [PASTE].
Deliver:
- The 1 north-star metric - defined precisely.
- 3 input metrics that move it, with formulas.
- 3 guardrail metrics so we don't optimize the wrong thing.
- Dashboard layout sketch (sections, charts, refresh cadence).
- The 1 vanity metric I am tempted to track and should not.
Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationmeasurementkpi
Objection handling script
Pre-empt and counter the toughest objections.
View full prompt
Build an objection-handling script for my documentation aimed at developers.
My offer / position: [PASTE].
The 3 most common objections I hear: [PASTE].
Deliver:
- For each objection: validate, reframe, evidence, ask.
- 2 objections I am probably not hearing but should expect.
- The single phrase to never say in response, and why.
Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationobjectionspersuasion
A/B test design
Design a clean experiment with one hypothesis.
View full prompt
Design an A/B test for my documentation with one clear hypothesis.
Current documentation: [PASTE].
Hypothesis (or what I'm curious about): [PASTE].
Traffic / sample size available: [PASTE].
Deliver:
- The hypothesis sharpened to one sentence.
- Variant A vs Variant B - only one variable changed.
- Primary metric and minimum detectable effect.
- Test duration and stop conditions.
- The decision rule before I peek at results.
Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationexperimentab-test
Narrative storyboard
Tell the documentation as a story, beat by beat.
View full prompt
Storyboard my documentation as a 7-beat narrative arc.
Subject: [PASTE].
Audience: developers.
Emotional outcome I want: [PASTE].
Beats: Hook → Stakes → Conflict → Attempt → Setback → Insight → Resolution.
For each beat: 1 sentence of action + 1 sentence of feeling. End with the single image the audience walks away with. Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationstorynarrative
Documentation glossary
Define the 20 terms anyone serious about technical documentation must know.
View full prompt
Build a glossary of the 20 most important terms in technical documentation as it relates to documentations and developers.
For each term:
- The term.
- A precise 1-sentence definition (no jargon recursion).
- 1 concrete example.
- The most common misuse I should watch out for.
End with the 1 term that is overused and meaningless. Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationglossaryreference
One-page cheat sheet
Compress everything I need into one printable page.
View full prompt
Produce a one-page cheat sheet for shipping a documentation in technical documentation.
Audience: developers.
Bias toward action, not theory.
Sections:
1. The 5-step quick path.
2. 3 hard rules (never break).
3. 3 soft rules (break with a reason).
4. Top mistake at each step.
5. The single check before publishing / shipping / sending.
Plain text, dense, under 400 words. Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationcheat-sheetreference
Anti-patterns to avoid
What NOT to do - with examples.
View full prompt
List the most damaging anti-patterns in technical documentation when producing a documentation.
Deliver:
- 8 anti-patterns.
- For each: a named label, a 1-line description, a real-sounding example of the failure, and the corrective principle.
- The anti-pattern that looks like best practice from the outside.
Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationanti-patternspitfalls
Recovery / damage-control plan
Stabilize after a technical documentation mistake.
View full prompt
My documentation or technical documentation effort went wrong. Build me a recovery plan.
What happened: [PASTE].
Who noticed: [PASTE].
Reversibility (1=easy, 5=baked-in): [PASTE].
Deliver:
- The first 24 hours: communications and operational steps.
- The next 7 days: trust-rebuild moves.
- The 30-day move that turns this into a credibility gain.
- The 1 thing I must NOT do in the first 24 hours.
Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationrecoverycrisis
90-day roadmap
Map out a quarter of focused technical documentation work.
View full prompt
Build a 90-day roadmap for serious progress on time-to-first-success in technical documentation.
Current state: [PASTE].
End state: [PASTE].
Resources: [PASTE].
Deliver:
- Month 1 / Month 2 / Month 3 themes (1 line each).
- 3-5 outcomes per month - each measurable.
- Dependencies and the order they must clear.
- The single bet I should kill if month 1 underdelivers.
Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationroadmapstrategy
Build a swipe file
Curate the best documentations I should be learning from.
View full prompt
Build me a swipe file of exceptional documentations in technical documentation to study, not copy.
My focus: time-to-first-success.
Audience I serve: developers.
Deliver:
- 10 exemplary documentations (real or plausibly real) with 1-line context for each.
- For each - the one technique to steal and the one tic to avoid.
- 3 patterns that show up across most of them.
- The exemplary documentation that is overrated and why.
Ask one clarifying question only if a hard blocker remains; otherwise proceed with stated assumptions. Use plain language, no fluff, no filler. Quote evidence when citing sources.
technical documentationswipestudy