Documentation of your AWS account, generated from the live account
Nobody keeps AWS documentation current, so when an audit, a handover or a new engineer needs it, it is missing or wrong. The Resource Documenter discovers your account and writes it up, inventory, applications, diagrams and a conformance read, as interlinked markdown.
The AWS documentation nobody has time to write
AWS account documentation is always the thing that did not get done. Then an auditor asks for it, a customer takes over an account, or a new engineer needs to understand what is running, and there is nothing accurate to hand over. The Resource Documenter discovers the account and writes the documentation for you, from what is actually there.
Discovery, then a written-up account
Point it at an account
Give it read-only access to the AWS account you want documented.
It discovers everything
It finds every resource across your regions and services, and the relationships between them.
It works out the shape
It groups resources into applications and identifies your environments, dev, test and production.
It assesses conformance
It runs a Well-Architected read on what it found, so the gaps land in the document too.
It writes the docs
Interlinked markdown, architecture diagrams, region and service summaries and an index you can navigate.
Run it again later
Each run is a snapshot, so a later run shows you exactly what changed.
Documents every resource in the account
A person documents the parts they remember. The agent documents what is actually running. It discovers every resource, works out which application each belongs to and which environment it is in, then writes it up so it reads like documentation rather than a console export.
- Discovers every resource across your regions and services
- Groups resources into applications by their boundaries
- Identifies your dev, test and production environments
- Maps how resources relate to each other
Architecture diagrams and a conformance read
It does not stop at a list. It draws the architecture from the live account and runs a Well-Architected read over what it found, so the documentation also tells you where the account is weak as well as what is in it.
- Architecture diagrams drawn from the live account
- A Well-Architected conformance assessment
- Per region and per service summaries
- An interlinked index, so it reads like docs
Run it again and see what changed
Documentation goes stale the moment it is written. Because each run is a snapshot of the account, a later run does not just refresh the docs, it tells you what changed since last time, so the documentation stays honest as the account evolves.
- Every run is a snapshot of the account
- Compare two runs to see exactly what changed
- Keep the documentation current as the account evolves
- Plain markdown, drop it in your repo or wiki
Built by base2Services
The documenter our engineers run when they take on a new AWS account, so they understand it before they touch it.
base2Services is an AWS Advanced Consulting Partner specialising in platform engineering and managed AWS operations. The Resource Documenter is part of how we run AWS for people, and it stands alone as a discovery deliverable. Point it at an account and you get the documentation that account never had.
