From template: https://developers.google.com/season-of-docs/docs/case-study-template
Organization or Project: Ushahidi, inc. (https://docs.ushahidi.com/platform-developer-documentation/hackathon-and-events/google-season-of-docs)
Organization Description: Update the technical documentation for The Ushahidi platform API
Authors:
<aside> 👉 What problem were you trying to solve with new or improved documentation?
</aside>
The documentation of the API for our Platform had been last updated in 2018, and since then, a new version of the API has been under development. Unfortunately, there had also been no documentation added for the new version’s endpoints. This was causing confusion for our users, delays in their work, and required sending questions and waiting for answers from our support team. It was also meaning our support team would spend time on tasks explaining what could be through the documentation, leaving less time for helping users with more complicated problems
<aside> 👉 A brief summary of your original organization proposal. Link to the proposal page on your project site, if possible.
</aside>
https://docs.ushahidi.com/platform-developer-documentation/hackathon-and-events/google-season-of-docs
The Ushahidi Platform is an open source tool and we have contributors working on our code as well as organisations that wants to extend the tool for their purposes.
For these users, up to date, clear and correct documentation of the REST API is essential. This project will create detailed documentation and establish clear maintenance procedures for the REST API documentation of the Ushahidi Platform.
We had been considering participating in Google Season of Docs in other occasions, however our team had already had their hands busy with other initiatives. This year, we could make sure we had the bandwidth to bring the project to success.
Selecting the topic for our proposal was straightforward, as our incomplete REST API documentation had been a sore point to our team for some time.
The proposal was put together by a member of our team taking point and obtaining requirements from other staff and our Community Advocate.