Technical Writer - Xray

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.

4. Documentation Standards and Quality
● Follow established technical writing standards, style guides, templates, and terminology guidelines.
● Apply clear information architecture, logical content organization, and consistent formatting.
● Use plain language and task-oriented writing wherever appropriate.
● Ensure documentation is accurate, concise, consistent, accessible, and easy to maintain.
● Follow established review, approval, publishing, and version-control processes.
● Incorporate feedback from technical experts, product teams, and end users.
● Maintain traceability between product changes, requirements, and documentation updates where applicable.
● Respect confidentiality, information security, and internal documentation policies.

5. Stakeholder Management and Continuous Improvement
● Gather documentation requirements from product managers, developers, QA teams, support teams, and other subject-matter experts.
● Ask relevant questions to clarify technical details and resolve ambiguities before publishing content.
● Manage multiple documentation tasks and deadlines across brands.
● Identify opportunities to improve documentation workflows, templates, tools, and collaboration practices.
● Communicate progress, blockers, dependencies, and priorities clearly.
● Contribute to a shared knowledge base and promote knowledge reuse across the organization.

Minimum Technical Skills and Qualifications
The ideal candidate should demonstrate the following minimum capabilities:
● Technical writing: Experience creating structured technical documentation, user guides, how-to articles, FAQs, and troubleshooting content.
● Jira knowledge: Working knowledge of Jira, including projects, issues, workflows, statuses, fields, filters, and basic navigation.
● Xray fundamentals: Basic understanding of Xray for Jira and software testing concepts, or the ability to learn the tool quickly.
● Software testing terminology: Familiarity with test cases, test plans, test executions, test cycles, test results, defects, and test coverage.
● Documentation tools: Experience with a documentation platform or knowledge base, such as Confluence, or a comparable tool.
● Content structuring: Ability to organize information using headings, procedures, numbered steps, tables, screenshots, and cross-references.
● Version control and change management: Basic understanding of document versioning, review cycles, change tracking, and maintaining accurate content.
● Technical comprehension: Ability to understand technical requirements, product behavior, workflows, and configuration instructions by working with subject-matter experts.
● Quality assurance: Strong attention to detail, consistency, terminology, grammar, and technical accuracy.
● Digital collaboration: Comfortable working with ticketing systems, shared documentation repositories, and distributed teams.

Preferred Qualifications
The following are advantageous but not essential:
● Previous experience documenting Xray or other Jira-integrated testing tools.
● Familiarity with software development lifecycles, Agile methodologies, Scrum, or Kanban.
● Experience working with QA, software development, product management, or support teams.
● Familiarity with REST APIs, JSON, webhooks, or integrations, particularly when documenting technical workflows.
● Experience with Markdown, Git-based documentation, or documentation-as-code practices.
● Knowledge of accessibility principles and technical content usability.
● Experience maintaining documentation across multiple products, brands, or business units.

Success Criteria
Success in this role will be measured by the ability to:
● Deliver accurate, useful, and up-to-date Xray documentation.
● Reduce ambiguity and improve the usability of technical information.
● Maintain documentation quality and consistency across assigned projects.
● Respond effectively to product changes and documentation requests.
● Collaborate successfully with colleagues across multiple brands.
● Contribute to shared documentation standards, knowledge exchange, and team efficiency.
● Balance primary Xray responsibilities with agreed cross-brand support priorities.

An Equal Opportunity Employer - All qualified applicants will receive consideration for employment without regard to race, color, religion, sex, sexual orientation, gender identity, national origin, disability, or status as a protected veteran.

By submitting your application, you acknowledge that Sembi, Inc. will process and retain your resume and related personal information solely for recruitment and hiring purposes. Resumes of unsuccessful candidates will be securely deleted within twelve (12) months of the hiring decision, unless a longer period is required by law or you provide explicit consent for continued retention (e.g., for consideration for future opportunities).

In compliance with applicable privacy laws, including the EU General Data Protection Regulation (GDPR), you have the right to request access to, correction of, or deletion of your personal information at any time by contacting compliance@sembi.com. Sembi, Inc. does not sell candidate data and will ensure that all personal information is processed securely and in accordance with relevant data protection regulations.