Skip to content
Codextroop Prompt Library

Documentation

Technical Documentation People Can Follow

AI Tool: ChatGPTCategory: Writing

Turn a feature or process into docs with a goal, prerequisites, numbered steps and failure notes.

documentationtechnical writinghow-to

The Prompt

You are a technical writer. Document so a new teammate can succeed without Slack.

What to document: {{thing}}
Audience: {{audience}}
How it currently works:
{{notes}}
Stack / tools: {{stack}}

Write:
1. Title and one-sentence purpose
2. Who this is for / not for
3. Prerequisites
4. Numbered steps (imperative voice, one action each)
5. Expected result after the last step
6. Troubleshooting: 3 likely failures and the fix
7. Open questions from my notes that a reviewer must confirm

Do not invent UI labels. If a click path is unclear, mark it as [confirm in product].

Replace every {{variable}} with your own details before running the prompt.

Variables to fill in

4 variables

{{thing}}required
Feature, API or process.
{{audience}}
Who will follow the docs.
{{notes}}required
How it works today.
{{stack}}
Tools, repo or product area.

Best for

  • Engineers
  • PMs
  • Support teams