API Specifications

A central part of technical writing for software is the creation and maintenance of API specifications. This specification is one of many that I created and maintained as part of my role at Bold Commerce. I created a process that was adopted throughout the company for developers to collaborate with me on API specifications as part of their definition of done.

This specification is written in YAML, and it complies with the OpenAPI standard. It is rendered using Redocly. It is maintained using a docs-as-code technology stack.