<p><p><b>Role Overview :</b><br/><br/>The Technical Writer 2 is responsible for designing, authoring, and maintaining high-quality technical documentation for Hylands software solutions.
</p><p><br/></p><p>This role requires hands-on use of the product, close collaboration with engineering and product management teams, and the ability to deliver structured, accurate, and developer-friendly documentation in fast-paced Agile and DevOps environments.<br/><br/>You will leverage DITA, XML/Markdown-based structured authoring, API documentation frameworks, and automation pipelines to create world-class user, developer, and administrator documentation that meets the needs of enterprise customers.<br/><br/><b>Key Responsibilities :</b><br/><br/><b>Documentation Engineering :</b><br/><br/>- Author, maintain, and optimize structured documentation (DITA/XML, Markdown, reStructuredText).<br/><br/></p><p>- Develop documentation for installation, configuration, deployment, integration, and troubleshooting of enterprise-grade software.<br/><br/></p><p>- Build and maintain API documentation (REST, SOAP, GraphQL) using tools like Swagger/OpenAPI, Postman, and Redoc.<br/><br/></p><p>- Leverage CI/CD pipelines (Jenkins, GitHub Actions, GitLab CI) to integrate documentation builds into release workflows.<br/><br/><b>Collaboration with Engineering :</b><br/><br/>- Work directly with developers, QA engineers, DevOps teams, and product managers to gather deep technical insights.<br/><br/></p><p>- Participate in sprint planning, product demos, and design discussions to anticipate upcoming documentation needs.<br/><br/></p><p>- Validate software functionality and escalate bugs, usability issues, or gaps to R&D stakeholders.<br/><br/><b>Content Development & Delivery :</b><br/><br/>- Create clear and concise documentation for administrators, end-users, and developers, covering installation, upgrade, configuration, and scaling scenarios.<br/><br/></p><p>- Develop content for SDKs, APIs, CLI tools, integrations, and automation frameworks.<br/><br/></p><p>- Contribute to internal knowledge bases, release notes, migration guides, and technical whitepapers.<br/><br/></p><p>- Ensure compliance with documentation standards, style guides, and versioning practices.<br/><br/><b>Tools & Standards :</b><br/><br/>- Utilize Atlassian suite (Confluence, JIRA, Bitbucket) for collaboration and tracking.<br/><br/></p><p>- Manage documentation source using Git/GitHub/GitLab and version control branching strategies.<br/><br/></p><p>- Troubleshoot documentation build pipelines (DITA-OT, Sphinx, MkDocs, DocFX, or similar).<br/><br/><b>Qualifications :</b><br/><br/>- Education : Bachelors degree in Technical Communication, Computer Science, Engineering, or a related technical field.<br/><br/>- Experience : 3+ years of technical writing experience in a software product development environment.<br/><br/><b>Required Technical Skills :</b><br/><br/>- Proven ability to install, configure, and troubleshoot enterprise software across Windows/Linux environments.<br/><br/></p><p>- Experience with API documentation, including REST and SOAP, with strong understanding of request/response models.<br/><br/></p><p>- Proficiency in DITA, XML, Markdown, or reStructuredText for structured authoring.<br/><br/></p><p>- Hands-on experience with documentation build frameworks (DITA-OT, Sphinx, MkDocs, DocFX).<br/><br/></p><p>- Strong command of Git-based workflows for version-controlled documentation.<br/><br/></p><p>- Familiarity with Agile/DevOps practices, CI/CD, and containerized environments (Docker/Kubernetes) is a plus.<br/><br/></p><p>- Knowledge of scripting languages (Python, Shell, or PowerShell) for automation/documentation tooling is highly desirable.<br/><br/><b>Soft Skills :</b><br/><br/>- Exceptional writing and editing skills with precision in technical detail.<br/><br/></p><p>- Strong analytical mindset and ability to quickly understand complex technical concepts.<br/><br/></p><p>- Excellent collaboration skills in cross-functional engineering teams.</p><br/></p> (ref:hirist.tech)