Wat de catalogus bevat
Twaalf categorieën, elk met de documenten die een team nodig heeft om een applicatie veilig te veranderen en te beheren:
- Product: visie, gebruikers, functies en bedrijfsregels
- Architectuur, data en koppelingen: het overzicht, het datamodel en de API's
- Beveiliging en privacy: toegang, geheimen en persoonsgegevens
- Kwaliteit en oplevering: de teststrategie, releases en terugdraaien
- Beheer: monitoring, backups en herstel na een storing
- Gebruikerservaring, mensen en werkwijze, en instructies voor AI-assistenten
Hoe we het beoordelen
We zoeken overal in je repository naar documenten: Markdown, API-beschrijvingen, beslisdocumenten, ook PDF en Word. Daarnaast lezen we de code zelf. Elk onderdeel krijgt een van drie uitkomsten, met de plek waar we het vonden:
- Aanwezig en actueel
- Aanwezig, maar dun of verouderd
- Ontbreekt
Waarom het nu telt
Met AI verandert code sneller dan iemand de documentatie bijwerkt. En een AI-assistent die aan je code werkt, leest diezelfde documentatie: wat ontbreekt of niet klopt, moet hij raden. Goede documentatie is daarmee ook goede input voor wie met AI bouwt.
Je eigen documenten blijven van jou
We schrijven niets in je repository. De uitkomst staat in je werkplek, met per onderdeel de plek waar we het vonden, zodat je team weet waar het aan de slag kan.