Smarter Week

How to automate it

How to automate “write technical docs, READMEs and design docs”

Here are 2 ways to spend less time on this, best first. Each comes with steps you can follow today and, for AI fixes, a prompt to copy.

60 min
typically, once a week
55%
of the time can be automated
Easy
to set up

Fix 1 of 2

AIBest fix

Generate docs and READMEs from the code with AI, then edit

A coding agent can read the module and write a first draft of the README, architecture notes or API docs, so you edit for accuracy instead of writing from nothing.

Typically saves about 45% of the time5 min to set up
  1. 1Run a coding agent in the repo and point it at the module.
  2. 2Use the prompt below and name the audience.
  3. 3Correct anything wrong and add the "why" that the code cannot show.
  4. 4Ask the agent to update the doc in the same PR whenever the code changes.
Prompt to copy
Read [MODULE OR FOLDER] and write a [README / design doc / runbook] for [AUDIENCE, e.g. a new engineer on the team]. Include: what it does, how to run and test it, the main components and how they talk to each other, config and environment variables, and known gotchas. Only describe what is in the code; mark anything you are inferring with [CHECK].

Tools: Claude Code, OpenAI Codex, Cursor, GitHub Copilot agent mode or Devin Desktop (ex-Windsurf)

Fix 2 of 2

AI

Start from an AI first draft, never a blank page

Give the AI your notes, the audience and an example you liked; you spend your time editing, which is faster and better.

Typically saves about 45% of the time5 min to set up
  1. 1Gather your notes, bullet points and a past document you liked.
  2. 2Tell the AI who it is for and what it must achieve.
  3. 3Ask for an outline first, adjust it, then ask for the full draft.
  4. 4Edit for facts and your voice.
Prompt to copy
You are helping me write a [TYPE OF DOCUMENT] for [AUDIENCE]. The goal is [WHAT IT MUST ACHIEVE]. Here are my notes: [PASTE]. Here is an example I like the style of: [PASTE]. First give me an outline. After I approve it, write the full draft. Don't invent facts; mark anything you are unsure of with [CHECK].

Tools: ChatGPT, Claude, Gemini or Microsoft Copilot

Who does this task

Roles in our library that list this as one of their common tasks. Each guide covers the rest of that role’s week.

Software engineerDevOps / Site reliability engineer

HourLeak · the 8-minute work audit

How many hours does this cost you?

The free 8-minute check works out where your week goes and gives you your top fixes. The team scan does the same for everyone and adds it up, so you know which leaks to fix first.

Take the free check Scan my team, $49

Answers are anonymous. Leaders only see team totals.

Other common tasks for Software engineers