Technical Writer

• Hyderabad, Telangana, India
• Permanent
• Product Development
• 10 - 14 years

Technical Writer

• Mentor, guide, and lead the documentation team to ensure the delivery of high-quality content that meets stakeholder needs and adheres to timelines.
• Help the team understand how to use and update existing personas, and identify and create new ones to enhance user understanding and engagement.
• Provide technical editing services to ensure that the final content is well-organized, presented appropriately, and error-free.
• Ensure that the user assistance created during this period is precise, usable, and reduces search time and user frustration.
• Identify long-term user assistance requirements and create roadmaps and frameworks for future UA innovation needs and opportunities, including multimedia content, video content, and AI assistants.
• Create the architecture of existing documentation and provide guidelines on how it can be interconnected with the UA.
• Develop a template and initial sample for API documentation in the UA portal to facilitate smooth and consistent documentation of APIs.
• Develop a template and sample for documenting Kafka messages to enhance user understanding of the messaging system.
• Create a template and sample for creating use cases that integrate our platform UI, REST API, and Kafka messages to guide users effectively.
• Review existing solution documentation and recommend an architecture for improved documentation, creating a Word template for consistency.
• Identify sections in the solution documentation that will typically remain unchanged and those that require dynamic updates, offering simple introductions and linking users to specific pages in our UA portal.
• Review existing training material, identify gaps, and propose enhancements to make it more accessible and memorable for users.
• If required, update the PowerPoint template for training material, ensuring it is well-structured and easy to use while maintaining its look and feel.