Easier collaboration in API documentation
Easier collaboration in API documentation

I code the front-end of Selfi Personal and Corp, so I'm a user of API documentation. I find Swagger and Trello quite lacking in terms of providing feedback on what kind of data I needed at the front-end. In a perfect scenario, the backend would be nicely planned out and all API are available for use when someone codes the front-end. In the case of a sole backend engineer, sole front-end guy and an ever changing requirements in a project, these platforms are pretty messy to use.

So I thought, why not use Google Docs for this. It turned out to be more useful than I had imagined, providing an interactive platform that allows feedback to flow in both directions (front-end to back-end, and back) for rapid development. It shows which API is currently live, under maintenance, or simple not completed yet. It shows feedback from both parties, allow one to raise issues against the other party and provides a single source of truth of what the final API would be like.

I find this collaboration method scalable and useable as the team grows.