Applying Generative AI Workflows to API documentation – AWS

As a principal early user and adopter of generative AI in documentation workflows at AWS, I became very interested in how it could help me quickly generate early draft API documentation for review. I worked out a method for our internal AWS tooling to generate API documentation in an XML format. In essence, searching and replacing placeholder text within an API feature based on a schema, in accordance with as-yet-unreleased information for the new features becoming available.

I worked out and documented a simple and straightforward series of steps for this, and shared it with the rest of my docs team and the division at large. I was very gratified to see it help others as much or more as it helped me. In essence, get to zero-level draft much more quickly, so I could then go through it and then take it back to engineers for further questions. Especially when time was at a premium in the lead-up to a launch, time saved for all.