Technical Publications Writer
- Bangalore, Karnataka
- Permanent
- Full-time
- Collaborate with engineers, QA, product management, and subject matter experts to research, gather, and understand highly technical product information.
- Design, develop, and deliver comprehensive technical documentation for hardware and software, including user manuals, installation guides, configuration guides, command-line reference manuals, and online help systems.
- Implement and champion the docs-as-code paradigm, treating documentation as a version-controlled codebase using plain text formats (e.g., Markdown) and Git.
- Help architect and optimize a documentation toolchain for automated content generation, leveraging CI/CD pipelines to build and deploy documentation.
- Recommend, evaluate, and integrate tools for automation, content analysis, and potentially AI-driven enhancements for documentation processes.
- Ensure that documentation is accurate, consistent, and adheres to established style guides and terminology standards.
- Create and update diagrams, illustrations, and other visual aids to enhance clarity and user comprehension.
- Actively participate in documentation reviews and incorporate feedback from technical teams and end-users to continuously improve content quality and usability.
- Proven technical writing experience with a strong portfolio of documentation samples for complex software and/or hardware products.
- Familiarity with the docs-as-code workflow, including experience with version control systems (e.g., Git) and plain text markup languages (e.g., Markdown).
- Experience using the Cursor IDE and appropriate extensions for Markdown rendering and linting.
- Experience with automated documentation build processes and static site generators (e.g., Sphinx).
- Proficiency with content creation tools and a willingness to adapt to new technologies and workflows (e.g. pandoc).
- Excellent written and verbal communication skills with the ability to translate complex technical concepts into clear, concise, and engaging content for diverse audiences.
- Strong research, analytical, and problem-solving abilities.
- Ability to work independently and collaboratively within an Agile development environment, managing multiple projects and meeting deadlines.
- Basic understanding of scripting languages (e.g., Python, Bash) to support automation efforts.
- Knowledge of best practices for continuous integration/continuous deployment (CI/CD) pipelines in a documentation context.
- Experience in migrating documentation from traditional authoring tools (e.g., Adobe FrameMaker) to docs-as-code environments.
- Familiarity with API documentation tools (e.g., Swagger/OpenAPI).
- Experience with AI-powered tools for content review, editing, or generation.