Skip to content
ballmüllersolutions logo Send an email Call us

Technical documentation for software

We write down how your software is built, how it is run and how new developers get started: from the code, by developers.

Book a first call

Capturing what is known about your software

When the knowledge about a piece of software sits in a few heads, every hand-over gets difficult. We read code and configuration, talk to your team and record what others need to know.

  • Architecture: structure, building blocks and the decisions behind them
  • Interfaces: API descriptions with examples and error cases
  • Data model: tables, relations and data flows
  • Operations: environments, delivery and what to do when something fails
  • Hand-over: getting started for new developers or a new provider

Who it is for

How it works

From the need to the hand-over in four steps.

1.

Clarifying the need

Who reads the documentation, and what for? Scope and form follow from that.


2.

Looking at what exists

We read code, configuration and existing documents and talk to the people who know the system.


3.

Writing

We write the chapters one after the other and agree them with your team.


4.

Hand-over

The documentation lives where your team works, for example next to the code, and we show how it stays up to date.


Price frame

ServiceFrame
Documentation by effort €160 per hour, €1,280 per day
Architecture and audit €220 per hour

These are guide figures, not quotes: all of them are non-binding and exclude VAT. We name the price for your project in our offer.

For clients in Switzerland: documentation CHF 200 per hour or CHF 1,600 per day, architecture and audit CHF 275 per hour.

Our cost calculator shows a first range for a software project in six questions.

Frequently asked questions

What belongs in technical documentation for software?

At least the structure of the software, its interfaces, the data model, its operation and how new developers get started. How deep it goes depends on who works with it.

Do you also write operating manuals for machines?

No. We document software and its operation. For operating manuals of machines and devices, technical writers are the right people to ask.

What does technical documentation cost?

We bill by effort: €160 per hour or €1,280 per day, architecture work €220 per hour. We estimate the effort up front, without obligation.

Do you also document software you did not build?

Yes. We need read access to the source code and someone from your team for questions.

How does the documentation stay up to date?

It works best next to the code, updated with every change. We set it up that way and show your team how it works.

Let's talk about your project

The first call takes 30 minutes on Microsoft Teams and is free and non-binding. Or describe your project in the project check and receive a brief with follow-up questions and a cost range.

Any questions?

Your contact person

Görkem Ballmüller