Guidance must be self-service and something stakeholders in API operations should have access to in their own time and space. Just-in-Time API Guidance ™ is kept as simple YAML and Markdown which can be managed and made available via simple GitHub, GitLab, or BitBucket repositories, as well as distributed and published to external systems as needed.
All aspects of API operations should be defined as part of the strategy, platform, policies, and rules, then possessing relevant guidance that provides an overview of each area of API operation. Just-in-Time API Guidance ™ makes it easy for product and engineering teams to learn while in motion, and obtain the knowledge they need to keep moving at the desired velocity.
Self-service guidance equips teams with the knowledge they need and guides them in their API journey, but with the right feedback loops in place it can encourage teams to provide feedback and improve upon guidance. This approach to providing education and training across the API lifecycle teaches teams to consume in a self-service way, reduces the number of meetings, while also encourages teams to use their voice to participate and evolve guidance, being the change they want to see when it comes to API operations.