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