Technical Writer – Xray

This is a fully remote position, open to applicants in United States.

📋 Description

• Create, review, update, and sustain technical documentation for Xray, encompassing user guides, configuration manuals, process documentation, FAQs, troubleshooting guides, and knowledge base articles.

• Convert intricate technical concepts, workflows, and requirements into clear, well-structured, and accessible content.

• Document the test management processes, which include test planning, execution, reporting, cycles, sets, and coverage.

• Ensure that documentation accurately reflects product functionality, configuration options, and software updates.

• Develop documentation tailored for end users, administrators, testers, and technical stakeholders.

• Identify gaps in documentation and propose enhancements.

• Maintain organized documentation, version-controlled where necessary, and ensure it is easy to locate and navigate.

• Document workflows, issue types, fields, statuses, permissions, and configurations related to Jira and Xray.

• Collaborate with product owners, developers, QA engineers, and other stakeholders to verify technical information.

• Record relationships between requirements, test cases, test executions, defects, and reporting.

• Document integrations and dependencies among Xray, Jira, and other relevant tools.

• Stay up-to-date with product updates and changes that impact documentation.

• Support other brands, shared documentation initiatives, and maintain consistent documentation standards.

• Adhere to technical writing standards, style guides, templates, terminology, and processes for review, approval, publishing, and version control.

• Incorporate feedback from technical experts, product teams, and end users.

• Gather documentation requirements and clarify technical details in collaboration with subject-matter experts.

• Manage multiple documentation projects and deadlines across various brands.

• Enhance documentation workflows, templates, tools, and collaboration practices.

• Communicate progress, challenges, dependencies, and priorities.

• Contribute to a shared knowledge base and encourage knowledge reuse.

⛳️ Requirements

• Proven experience in creating structured technical documentation, including user guides, how-to articles, FAQs, and troubleshooting content.

• Proficient understanding of Jira, encompassing projects, issues, workflows, statuses, fields, filters, and basic navigation.

• Basic familiarity with Xray for Jira and software testing concepts, or the ability to quickly learn the tool.

• Understanding of test cases, test plans, test executions, test cycles, test results, defects, and test coverage.

• Experience with documentation platforms or knowledge bases, such as Confluence, or similar tools.

• Capability to organize information using headings, procedures, numbered steps, tables, screenshots, and cross-references.

• Basic knowledge of document versioning, review cycles, change tracking, and maintaining accurate content.

• Ability to comprehend technical requirements, product behavior, workflows, and configuration instructions by working with subject-matter experts.

• Strong attention to detail, consistency, terminology, grammar, and technical precision.

• Comfortable using ticketing systems, shared documentation repositories, and working with distributed teams.

• Previous experience documenting Xray or other Jira-integrated testing tools is beneficial but not mandatory.

• Familiarity with software development lifecycles, Agile methodologies, Scrum, or Kanban is advantageous but not essential.

• Experience with QA, software development, product management, or support teams is beneficial but not mandatory.

• Familiarity with REST APIs, JSON, webhooks, or integrations is advantageous but not essential.

• Experience with Markdown, Git-based documentation, or documentation-as-code practices is advantageous but not essential.

• Knowledge of accessibility principles and technical content usability is advantageous but not essential.

• Experience maintaining documentation across various products, brands, or business units is beneficial but not mandatory.

🏝️ Benefits

• Competitive salary and comprehensive benefits package.

• Opportunities for professional development and career advancement.

• Flexible working hours and a supportive work environment.

• Access to the latest tools and technologies for documentation.

• Collaborative team culture that values innovation and creativity.