How to Use Claude as a Technical Writer: Docs From Specs, Release Notes, Ambiguity Review

10 Min. Lesezeit KissMySkills

Claude is strong at turning material that already exists (a spec, a ticket thread, a changelog) into a clean first draft, and at reading a page the way a confused user would. It is weak at facts it was not given: it cannot run your product, so it fills gaps with plausible behaviour. Work in three passes. First give it the source of truth and forbid anything outside it. Then ask for a draft with every assumption listed. Then switch roles and make it attack the draft for ambiguity. A person who can run the product still has to verify every step and every example.

Auf dieser Seite
  1. What does Claude need before it writes a word of documentation?
  2. How do you turn a spec into reference docs without invented behaviour?
  3. How do you turn tickets into release notes people read?
  4. How do you write a how-to from a messy support thread?
  5. How do you review a draft for ambiguity?
  6. Where does Claude fail at this?
  7. Which writing skill fits which job?
  8. How do you install a technical writing skill in Claude?
  9. Related guides
  10. Frequently asked questions
The skill this guide is built on
API Technical Writer AI Skill - Bodhi
API Technical Writer AI Skill - Bodhi
$19this skill, one-time

API Technical Writer AI Skill - Bodhi

Get API Technical Writer AI Skill - Bodhi →

What does Claude need before it writes a word of documentation?

The most common failure is asking for "documentation for our export feature" and receiving a polished page about an export feature that does not exist. Give it a source of truth and a reader.

The source. An OpenAPI file, a Postman collection export, a code comment block, a pull request description, a design doc. Paste the material itself, not your summary of it. If you have no source, you are writing from memory, and Claude will mirror your gaps.

The reader and what they are doing. "A backend developer integrating payments on a deadline" writes a different page from "an admin configuring SSO for the first time". Name the task, not the persona.

The document type. Tutorial, how-to, reference and explanation serve different readers; the Diátaxis framework describes the four and is worth ten minutes before you brief anyone. Tell Claude which one you want. A page that tries to be all four is the usual reason docs are unreadable.

Your style rules. Paste your house style, or name a published one you follow. Without it you get Claude's defaults: friendly, a little padded, with "simply" and "just" in places a stressed reader will resent.

What you do not know. List open questions. It is much better to have the draft carry [TO CONFIRM] markers than a confident guess.

How do you turn a spec into reference docs without invented behaviour?

A spec describes shape, not behaviour. Claude can render shape very well and will quietly invent behaviour. The prompt below separates the two.

You are writing reference documentation for one API endpoint. Use ONLY the spec below. Do not describe behaviour that is not stated in it. SPEC: [PASTE THE OPENAPI FRAGMENT FOR ONE ENDPOINT, INCLUDING SCHEMAS AND RESPONSES] Audience: [BACKEND DEVELOPERS INTEGRATING FOR THE FIRST TIME] Languages for samples: [CURL AND PYTHON] Style: [SECOND PERSON, PRESENT TENSE, NO "SIMPLY" OR "JUST"] Produce, in this order: 1. One-sentence purpose. 2. Request: method, path, auth, a parameters table (name, type, required, description, constraints taken from the spec). 3. Response: a table of fields with types, then the documented error responses. 4. One request and response example built only from spec examples or clearly invented placeholder values marked as placeholders. 5. A section called "Not in the spec" listing every question a developer would ask that the spec does not answer: rate limits, idempotency, pagination limits, field behaviour when null, ordering, retries. Where a description is missing, write [TO CONFIRM] rather than guessing. Do not copy field names into prose as if they explained themselves ("the user_id field is the user id").

The last line matters: restating a field name as its own description is the commonest low-quality docs habit, and models do it by default. Section 5 is the real deliverable. It turns "docs" into a short list of questions for the engineer, which is where the genuine value comes from.

Example output (illustration only, invented endpoint):

POST /v1/exports Creates an export job. Returns immediately with a job ID; the file is produced asynchronously. Parameters format string required One of: csv, json (from spec enum) since string optional ISO 8601 timestamp [TO CONFIRM: inclusive or exclusive?] Not in the spec - Maximum export size or row limit? - Is the job ID reusable for retries (idempotency)? - How long is the download URL valid?

How do you turn tickets into release notes people read?

Release notes written from ticket titles read like an internal to-do list. Users want "what changed for me and do I need to do anything".

Write release notes for [PRODUCT NAME] version [VERSION] from the items below. Readers are [ADMINS WHO MANAGE USERS], not engineers. ITEMS (ticket title, PR description, or changelog line): [PASTE 10 TO 30 ITEMS] Rules: - Group into: New, Improved, Fixed, Changed (needs action), Deprecated. Omit empty groups. - Each entry: one sentence in plain language that says what the user can now do or what no longer happens. Never reuse the ticket title verbatim. - Anything under "Changed (needs action)" must say exactly what the reader has to do and by when, using only dates given in the items. - Merge items that are the same change seen from different tickets. - Do not include internal refactors, test changes or dependency bumps unless they affect users. - Do not invent benefits, performance numbers or dates. If an item is too vague to describe, list it at the end under "Unclear, ask the engineer" with the question. Format: markdown, headings per group, no intro paragraph.

The "Unclear" bucket keeps the draft honest and gives you the list of questions to send to engineering. Run it once and expect to cut at least a third; the grouping is useful, but marketing adjectives creep in and should be stripped.

How do you write a how-to from a messy support thread?

Support threads contain the real task, the real wrong turns and the real fix. They are the best source for a how-to page, and the worst format.

Below is a support conversation where an agent walked a customer through a task. Convert it into a how-to article. THREAD: [PASTE THE ANONYMISED THREAD] Article goal: "How to [TASK, E.G. RESET A WORKSPACE OWNER]" Reader: [ADMIN WHO HAS NEVER DONE THIS] Rules: - Start with prerequisites (permissions, plan, things to have ready), taken only from the thread. - Numbered steps, one action each, starting with a verb. Put the expected result after the step, not before. - Add a "If this does not work" section built from the wrong turns in the thread, not from your own guesses. - Do not mention UI labels or menu paths unless they appear in the thread; otherwise write [CHECK UI LABEL]. - List at the end, separately, every step you could not verify from the thread. Return the article, then the unverified list.

UI labels are where Claude embarrasses writers: it names a button that was renamed two releases ago or never existed. The [CHECK UI LABEL] marker makes those visible. Someone must then run through the steps on a real account, and nothing in this workflow replaces that.

Another job, another skill

Whitepaper and Technical Marketing Writer, Amadora — $19. For the document a sceptical technical buyer reads to the end: one defensible differentiator, a claims register and sign-off flags on every number. Hands endpoint-and-parameter content back to the docs side.

View skill →

How do you review a draft for ambiguity?

This is where Claude earns its place regardless of who wrote the page. It will read what is on the page, not what you meant.

Act as a reader who is new to this product and follows documentation literally. Review the page below. Do not rewrite it. PAGE: [PASTE THE DOCUMENT] 1. List every sentence that can be read in two ways. Quote it, give both readings, say which a literal reader would pick. 2. List every pronoun or "it/this/that" whose referent is unclear. 3. List every step that assumes knowledge the page never introduced (a term, a tool, a permission). 4. List every place where order is ambiguous: steps that could be done in either order but where one order fails. 5. List every number or limit without a unit. 6. List words that are used for two different things (for example "project" meaning two objects). 7. List what is missing: the first question a reader would ask after finishing this page. Quote the text for every finding. If you find fewer than 5 issues in total, say what you did not check. Do not praise the page.

Point 6 (one word for two things) is the sort of defect that a human editor catches after weeks on a doc set and Claude catches in seconds. Follow it with a search of your glossary and fix the term once everywhere, not just on this page.

Another way in: a second skill for a different job
Whitepaper & Technical Marketing Writer AI Skill - Amadora
Whitepaper & Technical Marketing Writer AI Skill - Amadora
$19this skill, one-time

Whitepaper & Technical Marketing Writer AI Skill - Amadora

Get Whitepaper & Technical Marketing Writer AI Skill - Amadora →

Where does Claude fail at this?

It documents the product it imagines. Anything not in your source gets filled with a plausible default: rate limits, retry behaviour, permissions. The [TO CONFIRM] convention and a "Not in the spec" list are the controls.

It cannot run your software. Steps, screenshots, UI labels and error text must be verified by a person on a real account. Code samples must be executed, not admired.

Spec and reality disagree, and it trusts the spec. If an endpoint returns something the OpenAPI file does not describe, Claude will document the file. Pair it with real response payloads and your support tickets.

It smooths over your terminology. It will rotate synonyms for "workspace", "project" and "account" because variation reads nicely, which is exactly wrong for documentation. Give it a glossary and say terms are not to be varied.

It adds friendly padding. Openers like "In this guide we will explore" and reassurance between steps lengthen pages and slow scanning. Specify a word limit per step and no introductory paragraph.

It cannot decide what to document. Which pages matter, in what order, and what is deliberately left out are product and audience decisions. It can propose a structure; the call is yours.

Which writing skill fits which job?

SkillBest forPrice
API Technical Writer, BodhiReference pages from OpenAPI/GraphQL, auth, errors, webhooks, spec-vs-docs audits$19
Whitepaper and Technical Marketing Writer, AmadoraWhitepapers, technical briefs, benchmark papers for a technical buyer$19

How do you install a technical writing skill in Claude?

With an All-in-one subscription there is nothing to download. Open Customize → Connectors, click +, then Add custom connector, and paste https://mcp.kissmyskills.com/mcp. Sign in with your email, then ask for the skill by name, for example "load Bodhi". Signing in is free, and your first skill call starts a 7-day free trial with every skill. The same connector works in ChatGPT, Claude Code, Codex and Cursor; steps are on the connector page.

Bought the single file? It is a .skill file, a ZIP with SKILL.md inside. In Claude, turn on code execution under Settings → Capabilities, then open Customize → Skills, click +, choose Upload a skill and toggle it on. In ChatGPT or Gemini, open the ZIP and paste the contents of SKILL.md into custom instructions.

Need more than one specialist?

Buying API Technical Writer AI Skill - Bodhi gets you one file. The All-in-one subscription loads every skill in the catalog through one connector, in Claude, ChatGPT Business, Enterprise or Edu, Claude Code, Codex or Cursor, and keeps each skill updated when we improve it. $12 a month or $69 a year, with 7 days free and every skill included.

Start the free trial → Why a subscription beats buying files

Frequently asked questions

Is there a Claude skill for technical writing?

Yes. Bodhi, the API Technical Writer AI Skill ($19), writes reference documentation from OpenAPI or GraphQL specs, including auth, error codes and webhooks. For whitepapers and technical briefs aimed at technical buyers, Amadora ($19) builds the argument and a claims register.

Can Claude write API documentation from an OpenAPI spec?

Yes, for the shape of the API: endpoints, parameters, schemas and examples. It cannot know behaviour the spec leaves out, so ask it to mark gaps with [TO CONFIRM] and list unanswered questions such as rate limits, idempotency and pagination, then get answers from an engineer.

Can Claude write release notes from tickets?

Yes. Paste the ticket titles or changelog lines, name the reader, and ask for entries that say what changed for the user and what action is needed. Have it list vague items separately instead of inventing a benefit, and strip any marketing adjectives that appear.

How do I use Claude to review documentation for clarity?

Ask it to act as a literal-minded new reader and list ambiguous sentences, unclear pronouns, assumed knowledge, unitless numbers and words used for two things, quoting each. Tell it not to rewrite or praise the page, so you get findings rather than reassurance.

What is Claude bad at when writing technical documentation?

It documents behaviour it was not given, cannot run your software to verify steps or UI labels, trusts the spec over real responses, varies terminology that should stay fixed, and pads pages with friendly filler. A person who can run the product must check every step and example.

Skill · SKILL.md · Works with Claude & ChatGPTAPI Technical Writer AI Skill - Bodhi

API Technical Writer AI Skill - Bodhi

$19
Get API Technical Writer AI Skill - Bodhi →

Or get it with every other skill in All-in-one: $12/month, 7 days free, every skill.