---
type: method
slug: technical-documentation
title: "Write technical documentation"
category: "Technology & Development"
subcategory: "Code quality"
level: starter
source: https://deepstoryresearch.com/method/technical-documentation
publisher: Deepstory Research
---

> **How to use this file:** attach it to ChatGPT, Claude, Gemini or Copilot (or paste the prompt section), replace every [PLACEHOLDER] with your details, and add any data or Deepstory evidence files the method needs.

## When to use this method
- Onboarding developers.
- Open-sourcing or handing over a project.

## Prompt

# 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.

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