Skip to content

Technology

The engineers who write the documentation first

Some software teams refuse to write a line of code until the manual is finished. They ship slower, and break less.

Cover image Photo by Jakub Żerdzicki / Unsplash

The rule is simple: before anyone writes code, someone writes the page that explains how to use it. If the explanation is confusing, the design is wrong.

The teams we met that work this way are not slower in the long run. They spend fewer weeks fixing misunderstandings, and new colleagues learn the system by reading rather than by asking.

A monitor showing control software in a dark room
Reading the manual before the code exists. Photo by Christian Lue / Unsplash

It is an old idea, borrowed from engineering disciplines where mistakes are expensive. Software is finally old enough to need it.

Share

Ines Varga

Science and technology editor. Spends her weeks in laboratories and her weekends explaining them.

Stay curious.

One email every Monday: the five stories worth your time, and one idea to argue about.

Great! Check your inbox and click the link to confirm your subscription.