Frequently when tech writers start creating API documentation, a developer will ask, Why don’t we use Swagger? Swagger, or the OpenAPI specification, is an open standard for describing your REST API. The Swagger/OpenAPI spec, which is created in YAML or JSON, can be parsed by different tools, such as the Swagger UI framework. Swagger UI can create an interactive experience for users to try out your API calls using their own API keys. This can be a powerful addition to your API documentation, since it gives users a sandbox to experiment with your API in an immediate way.
As content ninjas in a global environment, editors often get asked to improve content created by non-native English speakers. While it can be challenging to edit this type of content, knowing the common mistakes can help you be more efficient and effective. In this presentation, we will discuss the common mistakes and how to work more effectively with these authors.
If your documentation process is implicated in a customer quality incident (CQI), Congratulations! You have the platform needed to shine a light on the problems you’ve been escalating for years.
In this presentation, Seth Park will argue that errors in documentation are actually symptoms of underlying data flow issues. If you don’t get involved in root-cause analysis, you’ll end up being asked for more reviews and checklists when you really need a more effective method for transferring data amongst teams. Continue reading “How to use root-cause analysis to promote information supply chain methodologies [On-line Event]”