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.