Skip to main content
MethodTechnology & DevelopmentCode qualityStarter

Write technical documentation

README, setup, architecture and how-to docs written for the reader who will use them.

This is a practical, copy-paste process for onboarding developers.. Use it when you want a clear structure, then add your own details and the linked evidence.

Published by Deepstory Research. Reviewed Sep 2026.

How to use this method

  1. 1. Copy or downloadCopy the prompt below, or download the method file and attach it to your chat.
  2. 2. Paste into any AIChatGPT, Claude, Gemini or Copilot. Replace each [PLACEHOLDER] with your details, or let the AI ask you.
  3. 3. Add evidenceAttach the evidence files listed on this page so the AI works from sourced numbers, not guesses.

The prompt

Paste it as-is. The AI will ask for anything still in [BRACKETS].

Download .md
# Write technical documentation
Method by Deepstory Research: deepstoryresearch.com/method/technical-documentation

You are a technical writer who is also an engineer. Follow the method below step by step. Goal: README, setup, architecture and how-to docs written for the reader who will use them.

## My inputs
- Project: [PROJECT]  (example: paste code structure and notes)
- Audience: [AUDIENCE]  (example: new developers)
- Doc types needed: [DOC_TYPES_NEEDED]  (example: README, setup, architecture)

Before you start: if any input above is still in [BRACKETS] or missing, ask me for it in one short numbered list and wait. Do not guess. If I attached files (data, briefs, Deepstory evidence files), treat them as the primary source.

## Steps to follow
1. Identify reader tasks.
2. Write a README with purpose, quickstart and links.
3. Write setup steps that can be copy-pasted.
4. Explain architecture and key decisions.
5. Add troubleshooting.

## Deliver the output in this structure
- README
- Setup guide
- Architecture overview
- Troubleshooting

## Quality rules
- Every command must be runnable as written.
- Label every number as FACT (with source and date), ESTIMATE (show the calculation) or ASSUMPTION.
- If a Deepstory evidence file is attached, use its figures as the reference values and cite its source references; tag claims that are not from it as [UNVERIFIED].
- End with: the 3 assumptions that matter most, what would change the answer, and the single best next step.

What you need to give the AI

InputPlaceholderExample
Project[PROJECT]paste code structure and notes
Audience[AUDIENCE]new developers
Doc types needed[DOC_TYPES_NEEDED]README, setup, architecture

Use it when

  • Onboarding developers.
  • Open-sourcing or handing over a project.

What you get

  • README
  • Setup guide
  • Architecture overview
  • Troubleshooting

The procedure, step by step

Read this before you run it, so you can check the AI actually followed the method.

  1. 1

    Identify reader tasks.

  2. 2

    Write a README with purpose, quickstart and links.

  3. 3

    Write setup steps that can be copy-pasted.

  4. 4

    Explain architecture and key decisions.

  5. 5

    Add troubleshooting.

Quality checks built into the prompt

  • • Every command must be runnable as written.
  • • Every number labelled FACT, ESTIMATE or ASSUMPTION; claims outside attached evidence tagged [UNVERIFIED].

Evidence for this method

This method runs on your own material: your files, brief or code. If your task needs market or economic numbers, attach a sourced context file from the evidence library alongside the prompt.

Browse evidence

Run next

Methods that chain well after this one.

AI Setup & ProductivityWrite an instruction file for AI agents (CLAUDE.md / AGENTS.md)A project instruction file telling coding or research agents what the project is, how to work and what not to do.Technology & DevelopmentReview code with AIA structured code review for correctness, security, performance and readability, with concrete fixes.Technology & DevelopmentDebug a problem systematically with AIA reproduce → isolate → hypothesise → verify debugging session ending in a root cause and fix.Technology & DevelopmentWrite automated testsA test plan and test code covering happy paths, edge cases and failures.

Deepstory methods are process guidance for AI tools. Review AI output before relying on it; legal, tax, medical and investment decisions need a qualified professional.