For engineers joining a team
Give a new engineer a path through the system
Your first ticket mentions a service you've never touched. Follow its connections in the graph, then open the documents that explain where it fits.
Sound familiar?
- I found the service, but I still don't know what calls it.
- There are three diagrams in the wiki. Which one should I trust?
- I'm waiting for someone to walk me through the request path.
Find the service behind a request
Search the text inside diagrams as well as document titles. A phrase from an endpoint description can take you to the service document even when you don't know its name.
Read the detail inside the overview
Embed a service diagram in the system map so the overview shows the source document. Updates to the source appear in its embeds; someone still needs to document changes to the system.
See how the diagram changed
Open version history to preview earlier revisions of a diagram. Check who edited it and when, then use the earlier view to ask about the change.
Your first service, start to finish
Find the service in search or the dependency graph.
Open its document and follow the request path.
Check earlier versions for the change you're working on.
Add the missing explanation for the next engineer.
C4 system context
Map an outreach platform, the person who uses it and its email provider.