Technical Writer - Xray
About this role
Role Overview We are looking for a detail-oriented and technically minded Technical Writer to support the documentation, knowledge management, and continuous improvement of Xray, a test management solution integrated with Jira.
The successful candidate will be responsible for creating, maintaining, and improving clear, accurate, and user-friendly technical documentation, helping users understand and effectively use Xray and its related workflows.
As Xray is one of several brands within our organization, this role also requires a collaborative, cross-brand mindset. While the primary focus will be on Xray, the Technical Writer may be required to support colleagues working on other brands, contribute to shared documentation initiatives, and help maintain consistent documentation standards across the wider organization.
Key Responsibilities 1. Technical Documentation ● Create, review, update, and maintain technical documentation for Xray, including user guides, configuration guides, process documentation, FAQs, troubleshooting guides, and knowledge base articles. ● Translate complex technical concepts, workflows, and requirements into clear, structured, and accessible content. ● Document test management processes, including test planning, test execution, test reporting, test cycles, test sets, and test coverage. ● Ensure documentation accurately reflects product functionality, configuration options, and software updates. ● Develop documentation for different audiences, including end users, administrators, testers, and technical stakeholders. ● Identify documentation gaps and proactively recommend improvements. ● Keep documentation organized, version-controlled where applicable, and easy to find and navigate.
2. Jira and Xray Knowledge ● Understand how Xray operates within the Jira ecosystem and how it supports software testing and quality assurance processes. ● Document Jira and Xray workflows, issue types, fields, statuses, permissions, and configurations where relevant. ● Work with product owners, developers, QA engineers, and other stakeholders to validate technical information. ● Understand the relationship between requirements, test cases, test executions, defects, and reporting. ● Document integrations and dependencies between Xray, Jira, and other relevant tools when applicable. ● Stay informed about relevant product updates and changes that may affect documentation.
3. Cross-Brand Collaboration ● Work primarily on Xray-related documentation while remaining flexible to support other brands within the organization. ● Collaborate with colleagues assigned to other brands, providing documentation support, sharing best practices, and contributing to common initiatives when needed. ● Assist with documentation projects outside the primary area of responsibility based on team priorities, workload, and business needs. ● Apply consistent documentation standards, templates, terminology, and quality expectations across brands. ● Share knowledge and expertise with other Technical Writers and cross-functional colleagues. ● Adapt documentation approaches to different products, audiences, and brand requirements while respecting each brand's identity and specific needs. ● Contribute to a collaborative team culture in which knowledge, resources, and expertise are shared rather than restricted to individual brand assignments.