REST API Documentation - Ready, Steady, Go!
In recent years, REST APIs are gaining popularity with developers. However, developers are usually not good at documentation or they do not like to write. As a result, the documentation that they create might not be very useful. Thereby, there can be an increase in the number of support calls. Also, lack of good documentation might not make the REST APIs reusable.
So, this scenario generates an opportunity for Technical writers to leverage their skills and develop REST API documentation from scratch.
Aparna is a Senior Technical Writer with SAS R&D, India Pvt. Ltd., Pune. Her core responsibilities include developing and publishing product documentation for web-based applications. Her 13 years of experience in technical writing encompasses diverse domains including banking, cash management, telecommunications, and graph and network theory. She is proficient in DITA, XML-based documentation, single sourcing, minimalist writing, embedded user assistance, and agile documentation methodologies. Keen on exploring the emerging trends for cloud-based documentation, she has chosen the theme of REST API documentation for STC this year.