Click here to see a sample of API documentation that I contributed to and wrote.
As a technical writer for API documentation, my role in this project:
- Standardize exisiting documentation
- Update and edit all to make more readable and add in the “why” behind things
- Restructure and rewrite the Introduction
- Add additional fields to API samples and test to make sure all are accurate
- Update example responses
In all projects, I am able to write thorough documentation that is verified. I am able to verify and test APIs without developer help.