Technical Writer – Software Documentation

HR Service Jobs; Town of Vegreville; Hybride; CAD 65 000 - 95 000; Plein temps

Résumé du poste

HR Service Jobs is seeking a detail-oriented Technical Writer – Software Documentation to create, maintain, and improve clear documentation for software applications and digital platforms. You will work with developers, product managers, QA, business analysts, and customer support to translate complex technical information into accessible content.

You will develop user guides, API references, release notes, and knowledge-base resources, while maintaining consistent documentation standards across

Qualifications

• Bachelor's degree or equivalent in relevant field is preferred.
• Excellent written English and editing skills.
• Ability to explain complex technical concepts clearly.
• Familiarity with documentation tools such as Word/Docs/Confluence/Notion.
• Knowledge of Markdown/HTML and basic APIs desirable.
• Experience with agile environments is beneficial.

Responsabilités

• Create software documentation including guides, manuals, specs, and release notes.
• Collaborate with developers, product managers, QA, and support to gather information.
• Prepare API references and developer docs when required.
• Develop FAQs and knowledge-base articles for troubleshooting.
• Maintain documentation standards and version control.
• Update content as features change.

Connaissances

Technical Writing

API Documentation

Information Design

Research

Formation

Bachelor's degree or equivalent

Outils

Confluence

Notion

Markdown

HTML

Description du poste

Job Summary

HR Service Jobs is seeking a detail-oriented and technically skilled Technical Writer – Software Documentation to create, maintain, and improve clear, accurate, and user-friendly documentation for software applications, digital platforms, and technical systems. The successful candidate will work closely with software developers, product managers, quality assurance engineers, business analysts, and customer support teams to translate complex technical information into accessible content for different audiences.

Key Responsibilities

• Create Software Documentation: Develop comprehensive documentation for software applications, including product guides, user manuals, technical specifications, system overviews, and feature descriptions.
• Collaborate with Technical Teams: Work with developers, engineers, product owners, QA specialists, and subject matter experts to gather technical information and ensure documentation accuracy.
• Prepare User Guides: Write step-by-step instructions that help end users install, configure, navigate, and use software products effectively.
• Document APIs and Integrations: Prepare API references, integration instructions, authentication guidance, request and response examples, and other developer-focused documentation when required.
• Develop Troubleshooting Resources: Create FAQs, error-resolution guides, diagnostic procedures, and knowledge-base articles to help users resolve common software issues.
• Maintain Documentation Standards: Follow established writing guidelines, terminology standards, templates, version-control practices, and documentation structures.
• Update Existing Content: Review and revise documentation whenever software features, interfaces, configurations, or technical processes change.
• Prepare Release Notes: Document new features, improvements, bug fixes, known issues, compatibility changes, and important updates for software releases.
• Conduct Technical Research: Review product requirements, source materials, technical specifications, test environments, and existing documentation to develop a thorough understanding of software functionality.
• Validate Documentation: Test documented procedures, verify screenshots and examples, and collaborate with technical teams to ensure instructions are accurate and reproducible.
• Organize Knowledge Resources: Maintain structured documentation repositories and knowledge bases so users and internal teams can locate information quickly.
• Support Product Launches: Prepare documentation and supporting content for new product features, software releases, system upgrades, and implementation projects.
• Improve Content Accessibility: Use clear language, logical headings, descriptive links, consistent formatting, and appropriate visual aids to improve readability and usability.
• Manage Documentation Projects: Prioritize assignments, monitor deadlines, coordinate reviews, and ensure documentation is delivered according to project schedules.
• Incorporate Feedback: Gather feedback from users, developers, support teams, and reviewers to identify gaps and continuously improve documentation quality.

Required Skills and Qualifications

Bachelors degree or equivalent qualification in English, Technical Communication, Computer Science, Information Technology, Engineering, Journalism, or a related discipline is preferred.

Excellent written English, grammar, spelling, punctuation, and editing skills.

Ability to explain complex technical concepts in clear, concise, and understandable language.

Strong research, information-gathering, analytical, and problem-solving abilities.

Understanding of software development processes, application functionality, and technical terminology.

Familiarity with documentation tools such as Microsoft Word, Google Docs, Confluence, Notion, or similar platforms.

Knowledge of Markdown, HTML, or other structured documentation formats is beneficial.

Familiarity with Git or other version-control systems is an advantage.

Basic understanding of REST APIs, JSON, XML, databases, web applications, and software integrations is desirable for relevant assignments.

Ability to organize technical information into logical sections, workflows, procedures, and reference materials.

Strong attention to detail when reviewing technical instructions, code examples, screenshots, and product terminology.

Ability to manage multiple writing assignments while maintaining accuracy and meeting deadlines.

Effective communication and collaboration skills when working with technical and non-technical stakeholders.

Willingness to learn new software tools, documentation platforms, and product technologies.

Ability to accept constructive feedback and incorporate technical review comments efficiently.

Experience

Candidates with 0–2 years of experience in technical writing, content development, documentation, editing, or a related field may be considered, depending on the role requirements.

Previous experience creating software documentation, user manuals, product guides, FAQs, or knowledge-base articles is an advantage.

Experience working with software development teams, SaaS products, IT services, or technology companies is desirable.

Familiarity with Agile or Scrum environments and software release cycles is beneficial.

Experience documenting APIs, software integrations, system configurations, or developer workflows is an added advantage for technically complex projects.

Candidates without formal technical writing experience may be considered if they demonstrate strong writing skills, technical aptitude, research ability, and a relevant writing portfolio.

Applicants may be asked to provide writing samples or complete a short documentation exercise to demonstrate their ability to explain a technical process accurately and clearly.

Working Hours

Job Type: Full-time, with part-time or contract arrangements subject to business requirements.

Work Arrangement: Remote, hybrid, or office-based, depending on the position and company policy.

Working Schedule: Typically aligned with the organizations standard business hours and project deadlines.

Weekly Schedule: Generally five working days per week for full-time employees.

Flexibility: Flexible scheduling may be available for eligible remote roles, provided deadlines, meetings, and collaboration requirements are met.

Team Meetings: Participation in documentation reviews, product discussions, project updates, and technical meetings may be required.

Availability: Candidates should be comfortable coordinating with colleagues across different departments and time zones when necessary.

Final working hours, time-zone requirements, employment status, and flexibility will be confirmed during recruitment.

Knowledge, Skills and Abilities

Technical Knowledge

• Understanding of software applications, system workflows, product features, and basic software architecture.
• Familiarity with technical documentation principles, content organization, and information design.
• Basic knowledge of APIs, web technologies, databases, and software development terminology.
• Awareness of version control, content publishing, and documentation maintenance processes.
• Understanding of quality assurance procedures and the importance of technical accuracy.

Writing and Editing Skills

• Ability to produce clear, structured, professional, and audience-focused documentation.
• Skill in converting complex technical explanations into straightforward instructions.
• Ability to write procedural content, reference materials, tutorials, FAQs, and release notes.
• Strong proofreading and editing abilities to identify inconsistencies, ambiguity, and errors.
• Ability to adapt tone, depth, and terminology for end users, developers, administrators, and internal teams.

Organizational Abilities

• Ability to manage documentation priorities, deadlines, and multiple concurrent assignments.
• Strong attention to detail and commitment to maintaining accurate records.
• Ability to structure information using headings, tables, lists, diagrams, and examples.
• Confidence in tracking revisions, incorporating reviewer feedback, and maintaining content consistency.

Communication and Collaboration

• Ability to ask relevant questions and gather information from subject matter experts.
• Confidence in communicating with technical teams and clarifying unfamiliar concepts.
• Ability to work independently while contributing effectively to collaborative projects.
• Professional approach to feedback, problem-solving, and continuous improvement.

Personal Attributes

• Curious, organized, dependable, and eager to learn.
• Comfortable working with evolving technologies and changing product requirements.
• Committed to producing accurate, useful, and accessible documentation.
• Able to identify documentation gaps and recommend practical improvements.
• Focused on helping users understand software and complete tasks successfully.

Benefits

• Flexible Work Options: Remote or hybrid working opportunities for eligible positions.
• Competitive Compensation: Salary or contract rates based on skills, experience, responsibilities, and market conditions.
• Professional Development: Opportunities to improve technical writing, editing, software documentation, and content management skills.
• Technical Learning: Exposure to software products, development methodologies, digital platforms, and emerging technologies.
• Career Advancement: Opportunities to progress into senior technical writing, documentation management, content strategy, or technical communication roles.
• Collaborative Environment: Opportunities to work with developers, engineers, product managers, and other technology professionals.
• Skill Development: Practical experience with documentation tools, version control, API references, and knowledge-management systems.
• Performance Recognition: Potential recognition for documentation quality, project delivery, and contributions to product usability.
• Work-Life Balance: Scheduling flexibility where supported by the role and operational requirements.

Specific salary details, paid leave, insurance, equipment allowances, bonuses, and other benefits will be communicated during the hiring process. Benefits should not be considered guaranteed unless confirmed in the official employment offer.

Why Join HR Service Jobs?

Joining HR Service Jobs as a Technical Writer – Software Documentation offers an opportunity to build a career at the intersection of technology, communication, and user experience.

The role provides an opportunity to turn complex software information into practical resources that help customers, developers, and internal teams work more effectively. It is suitable for experienced technical writers who want to expand their expertise and for capable candidates who want to develop a career in technical communication.

You may have opportunities to:

• Contribute to the quality and usability of software products through accurate, helpful documentation.
• Develop a portfolio of professional technical writing projects.
• Strengthen your understanding of software development, product functionality, and technical systems.
• Collaborate with professionals from engineering, product development, QA, and customer support.
• Learn industry-standard documentation tools and structured writing techniques.
• Build transferable skills in research, editing, content design, project coordination, and knowledge management.
• Pursue long-term career growth in technical communication, developer documentation, content operations, or documentation leadership.

HR Service Jobs seeks candidates who value accuracy, clear communication, teamwork, and continuous learning. If you enjoy explaining how technology works and making information easier to understand, this position may be an excellent opportunity to apply your strengths and develop your professional capabilities.