ChatGPT Prompts for Technical Writing: Docs People Can Follow

Technical writing is about getting someone from stuck to done with the fewest possible words. ChatGPT is a strong partner for it: it turns rough engineering notes into steps, rewrites dense paragraphs for beginners and spots where instructions skip a step. What it can't do is know whether your instructions are right. The prompts below use it for structure and clarity, with a clear style to follow, and leave the facts to you.

A style to put in every prompt

Without a style, ChatGPT writes in a slightly formal, slightly padded voice. Google's developer documentation style guide gives you a well-tested set of rules to point it at:

Google's style guide says	In practice
Be conversational and friendly without being frivolous	Write like a helpful colleague, not a legal notice
Use second person: 'you' rather than 'we'	'You can export the file' instead of 'We can export the file'
Use active voice and make clear who performs the action	'Select Save' instead of 'Save should be selected'
Use sentence case for titles and headings	'Set up your account', not 'Set Up Your Account'
Write for accessibility and a global audience	Short sentences, no idioms, alt text for images

The catch: OpenAI says ChatGPT can produce incorrect output, and in technical writing a confident wrong step is worse than a missing one. Give it your verified notes, then test every procedure it writes by following it yourself.

Prompts to turn notes into documentation

Paste your rough notes and say who'll read the result.

Copy this prompt

Turn these rough notes into step-by-step instructions for [audience] who want to [task]. Use numbered steps, second person and active voice, one action per step. Use only my notes: [paste].

Copy this prompt

Write a short how-to article from these notes with a one-line summary, prerequisites, numbered steps and a 'what to do if it doesn't work' section.

Copy this prompt

Draft a README for this project from the description below: what it does, how to install it, how to use it and where to get help. [paste details]

Copy this prompt

Turn this list of changes into release notes for non-technical users, grouped into new features, improvements and fixes: [paste].

Copy this prompt

Write a quick-start guide that gets a new user to their first result in five steps or fewer, using these details: [paste].

Prompts to edit for clarity

For drafts that are accurate but hard to follow.

Copy this prompt

Edit this text to follow Google's developer documentation style: second person, active voice, sentence case headings, short sentences. List the main changes you made: [paste].

Copy this prompt

Rewrite this paragraph for a beginner without changing its meaning, and flag any term that needs a definition: [paste].

Copy this prompt

Find every place in these instructions where a step is assumed but not stated: [paste].

Copy this prompt

Shorten this section by a third without losing any instruction or warning: [paste].

Copy this prompt

Turn this long paragraph into a numbered procedure and a short note for any warnings: [paste].

Prompts for structure and consistency

Docs get messy as they grow.

Copy this prompt

Suggest a structure for documentation about [product or process], with section headings and what each section should cover.

Copy this prompt

Check this document for inconsistent terms, such as using two names for the same button, and list each one: [paste].

Copy this prompt

Create a glossary of the technical terms used in this document, with a plain-English definition for each.

Copy this prompt

Write a style sheet for our documentation: tone, person, voice, capitalisation, how we refer to UI elements and how we format code.

Prompts for specific document types

Different documents, different jobs.

Copy this prompt

Write a troubleshooting guide for [problem] with symptoms, likely causes and fixes in a table.

Copy this prompt

Draft an FAQ for [product] based on these support questions: [paste questions].

Copy this prompt

Write an internal process document for [process] with purpose, roles, steps and what to do when something goes wrong.

Copy this prompt

Turn this API endpoint description into reference documentation with a summary, parameters, an example request and an example response: [paste details].

Prompts to review before publishing

The last pass before readers see it.

Copy this prompt

Read these instructions as a first-time user and tell me where you'd get stuck or confused: [paste].

Copy this prompt

Check that every step in this procedure starts with a verb and contains a single action.

Copy this prompt

List any claims in this document that I should verify before publishing.

Copy this prompt

Check this document for accessibility: missing alt text descriptions, vague link text, tables without headers and headings out of order.

Copy this prompt

Rewrite any idioms or culture-specific phrases in this text so it reads clearly for a global audience and translates well.

Prompts for screenshots and visuals

Words and images should tell the same story.

Copy this prompt

Suggest where screenshots or diagrams would help most in these instructions, and what each one should show: [paste].

Copy this prompt

Write alt text and a one-line caption for each of these screenshots, based on my descriptions: [describe screenshots].

Copy this prompt

Turn this process into a simple flowchart description I can hand to a designer, with each decision point clearly marked.

How to get better technical writing from ChatGPT

• Name the reader and the task they want to complete.
• Give it a style to follow, such as Google's developer documentation guide.
• Feed it verified notes, and tell it to use only what you provide.
• Follow every procedure yourself before you publish it.
• Keep a context document with your product names and terms so it stays consistent.

A short context document with your product names and terms keeps ChatGPT consistent across every doc, and custom instructions can store your style rules permanently. My AI prompt examples show the difference a precise brief makes.

My advice on ChatGPT prompts for technical writing

Let ChatGPT handle the shaping: turning notes into steps, cutting padding and enforcing a consistent style. Keep the truth with the people who know the product, and test every procedure before it goes out. If you only add one thing to your prompts, make it a named style guide, because it turns a passable draft into something that reads like it came from one careful writer.

Related: the technical writing page.

Frequently asked questions

Can ChatGPT write technical documentation?

Yes, from your notes. It's good at structure, steps and clarity, but you need to supply accurate information and test every procedure.

What style should technical writing follow?

Google's developer documentation style guide is a good default: conversational but not frivolous, second person, active voice and sentence case headings.

How do I make ChatGPT write in second person?

Say so in the prompt: 'use second person (you), active voice and one action per step', and ask it to list the changes it made.

Can ChatGPT make mistakes in technical docs?

Yes. OpenAI says ChatGPT can produce incorrect output, so give it verified notes and follow every instruction yourself before publishing.

What's a good prompt for release notes?

Paste the list of changes and ask for release notes for non-technical users, grouped into new features, improvements and fixes.