Is your software documented well enough to maintain?

We set your documentation against a fixed catalogue of what a maintainable application needs, from architecture to recovery after an outage. For each item you see what's there, what's thin or outdated, and what's missing.

Updated

What the catalogue holds

Twelve categories, each with the documents a team needs to change and run an application safely:

  • Product: vision, users, features and business rules
  • Architecture, data and integrations: the overview, the data model and the APIs
  • Security and privacy: access, secrets and personal data
  • Quality and delivery: the test strategy, releases and rolling back
  • Operations: monitoring, backups and recovery after an outage
  • User experience, people and ways of working, and instructions for AI assistants

How we score it

We look everywhere in your repository for documents: Markdown, API descriptions, decision records, PDF and Word too. We also read the code itself. Each item gets one of three outcomes, with where we found it:

  • Present and current
  • Present, but thin or outdated
  • Missing

Why it matters now

With AI, code changes faster than anyone updates the documentation. And an AI assistant working on your code reads that same documentation: what's missing or wrong, it has to guess. Good documentation is good input for anyone building with AI.

Your own documents stay yours

We write nothing into your repository. The outcome is in your workspace, with where we found each item, so your team knows where to start.

Questions we often get

Do we need everything in the catalogue?

No. Not every item fits every application, and what doesn't fit doesn't count. The catalogue shows the gaps that hurt maintenance most.

Do you write the missing documentation?

Not in the pilot. In it we check, and show what's there and what's missing.

Do you read documents outside the repository too?

Yes, if you put them in your workspace. They count like the rest, with where they are.

Sign up for the pilot

The pilot is by invitation. Sign up, we check whether your application fits and email you. You connect your repository with read access only, the first check starts by itself, you see what is checked and what is proven, and then we ask what it is worth to you. Have a question first? Ask it in the message below.

Our team

Reads every sign-up and every question

Our team reads what you send and answers by email. A conversation only happens if you ask for one: with the people who do the work, not a salesperson.

We only use your details to respond to your sign-up. The website doesn't keep your request.