Technical Writing

• Getting started and programming guide doc – A quick start guide with high level overview of the organization of document contents with pointers to the correct topics. Classification of document based on topics and programming guide for each section. Programming guides to be written topic wise. Clear diagrams and explanation of topics to be documented. • API documentation in HTML, PDF format – Programming API docs to be written and ouput in HTML, PDF formats expected. API calls to be explained details on end points, request payload and response payload. REST APIs exposed by various micro services to be documented. • Product architecture and deployment details – Product architecture with diagrams showing interconnect between various services and modules of the platform. Documentation of deployed services with respresentation of VM computes, API gateway, load balancers, data bases etc … to be documented. • Ingestion and integration documentation – Ingestion pipeline flow to be documented with the ingestion pipeline services sequences explained and meta data model of the pipeline explained using documentation. Technical support to do this will be provided.