AWS · Technical documentation
AWS application documentation
Summary
Architecture and dependency information was spread across different sources. I started to create a common document for each service.
- My role
- Data collection, validation, diagrams and documentation.
- Content
- Architecture, dependencies, access and operations.
- Status
- In progress.
- Goal
- Reduce dependency on undocumented knowledge.
My approach
For each application, I identify the resources it uses, how they communicate, where the data is stored, which scheduled tasks exist and which dependencies could affect a change.
The diagrams help explain the full setup, while the documentation also includes the information needed to operate and review the service.
Result
The documentation brings architecture, dependencies and decisions from different sources into one common model. The base is ready, and I keep expanding it as I review more applications.