Key Responsibilities
Technical Documentation Creation & Maintenance
- Develop and maintain comprehensive user documentation for Spark Assist application functionality
- Create detailed workflow and process flow documentation
- Write clear, concise API documentation including endpoints, parameters, and integration guides
- Produce user guides, quick start guides, and troubleshooting documentation
- Develop onboarding materials and training documentation for new users
- Create integration guides for developers and technical stakeholders
- Maintain API reference documentation with code examples
- Maintain version control and ensure documentation accuracy across application updates
Collaboration & Quality Assurance
- Work closely with product managers, developers, and UX designers
- Review and edit documentation for clarity, accuracy, and consistency
- Establish and maintain documentation standards and style guides
- Conduct regular documentation audits and updates
Required Qualifications
Technical Skills
- 5+ years of experience in technical writing, preferably for software applications
- Proficiency in documentation tools (e.g., Confluence, github)
- Experience with API documentation tools (e.g., Swagger, Postman)
- Basic understanding of software development processes and terminology
- Familiarity with markup languages (Markdown, HTML)
Communication & Analytical Skills
- Excellent written and verbal communication skills
- Ability to translate complex technical concepts into user-friendly language
- Strong attention to detail and organizational skills
- Experience working in Agile development environments
- Adding some more context:
- TW is required for the Spark Assist project
- Will be required to draft dev as well as end user documentation
- Since SparkAssist is likely to be rolled out to external user very soon, the whole app knowledge base, user guide etc etc will need to be written by TW
- The writeup will also go on LerningXchange may form a part of regular training material.
- This will be a long term role, will full clarity and visibility atleast this end of year and beyond that point # 4 will kick in (FY 26)
