In order to deploy, modify, or decommission instrumentation, product teams will be asked to navigate a set of processes for event stream configuration and event schema, often both at once. This is inherently more complicated than the current process, which only modifies a single artifact (an event schema), and does that on-wiki in a familiar interface. This documentation is needed to make the new workflows more approachable and less of a burden. If that can't be done, it will jeopardize adoption.
Given the current ease-of-use, it's important for this replacement's documentation to focus on:
- Streamlining as much as possible without sacrificing safety
- Being usable by those who may not deploy software very often
- Illustrating the advantages of the processes, and how to use them