Building technical documentation as a product at scale
Submitted by Ravi Suhag (@ravisuhag) on Wednesday, 3 October 2018
In the real world, when we buy a product, it comes with a quick guide or some other form of documents which help you get going with the product. Without these documents, we’ll have to learn how to use the product leveraging solely on the ‘trial and error’ method — which is not a pleasant user experience at all.
We support and build data products for more than 15 internal teams. Our target audience includes product managers, developers, operation managers, and business analysts. Hence:
We faced problems in communicating what the Data team is working on and what is next in our product lineup.
It was getting harder to make clear that there is something missing in their life and that is our product/service.
We found ourselves handling support requests on a daily basis, consuming a lot of our core development time.
Worst of all, for developers, data engineering became equivalent to Firehose (data consumption toolkit). For business analysts, we were Dagger team (data aggregation toolkit), for OMS teams we were fronting team.
Need of technical documentation for your product
- Reserach - Content - Design - Development Delivery
Ravi Suhag is Data Engineer at GO-JEK