Documentation Expert - Technical Writer

Veracity Software Inc; Victoria; Remote; CAD 60,000 - 100,000; Full time

Job summary

An established industry player is seeking a Documentation Expert to join their team for a high-impact government project. This role involves developing clear and concise technical documentation, including user guides and API documentation, while collaborating closely with developers and project managers. The ideal candidate will have over five years of experience in technical writing, particularly in regulated environments, and possess exceptional communication skills. This exciting opportunity allows for remote work from anywhere in Canada, providing flexibility while contributing to a project that modernizes essential government services. If you're passionate about documentation and knowledge transfer, this role is perfect for you.

Benefits

Remote Work Flexibility

Professional Development Opportunities

Health and Wellness Programs

Flexible Hours

Collaborative Team Environment

Qualifications

• 5+ years of experience in technical writing, especially in government contexts.
• Exceptional written and verbal communication skills for diverse audiences.
• Proficiency with documentation tools and Agile methodology.

Responsibilities

• Develop and maintain high-quality documentation, including user guides.
• Standardize documentation practices to align with team requirements.
• Conduct training sessions to enable knowledge transfer.

Skills

Technical Writing

Communication Skills

Documentation Tools (Confluence, GitHub)

API Documentation

Agile Methodology

Organizational Skills

Knowledge of Security Standards

Education

Technical Writing Certification

Bachelor's Degree in a Related Field

Tools

Confluence

GitHub

Job description

Requisition Name: Documentation Expert - Technical Writer

Location of Services: Victoria (Remote anywhere in Canada)

GDX office place is 4000 Seymour Place, Victoria BC. The resources can work remotely and must be fully accessible via video conferencing for all meetings and scrums. On-site meetings may be required from time to time.

Branch/Dept/Office: Service BC & GDX

Project Name: Government's Media Monitoring & Insights (MMI) Project and technology modernization

This is a procurement for 1 of, Technical Writer as further described in the Requisition and section 3 of this RFP, to work as the Documentation Expert on the BC Government's Media Monitoring & Insights (MMI) Project and technology modernization of the Province's Custom Web Platform. These roles can be performed remotely within Canada and resources must be available from 8:00 AM to 5:00PM PST or as per business needs.

Estimated Work Start Date: 02-Jan-2025

Estimated Work End Date: 31-Mar-2025

Position: Technical Writer

# of Positions: 1

Standard Hours Per Day: 7.00

Estimated Work Days: 63.00

Technical Writers prepare technical and user guides for software applications, and may be asked to review development and project documentation.

A Technical Writer requires the following skills set:

• Develop documentation of technical and user guides in support of application management and use;
• Identify audiences for document and structure the document appropriately;
• Interview developers, business analysts, project managers and other project resources for input to document scope and organization;
• Review project deliverables (documents) for:
• organization of document is appropriate to subject matter (or complies with standards),
• tone and level of complexity are suitable for audience, and
• grammar and punctuation enhance readability and comprehension; and
• Perform copy edit on project and development documentation, e.g. specifications, reports, plans, briefing notes, and position papers.
  
  

The Documentation Expert is required to have the following skills and experience:

• The Documentation Expert will develop and maintain detailed, clear documentation, enabling knowledge transfer and facilitating future development and maintenance efforts.
  
  

In addition to the skills and experience set out above, the Proponents should demonstrate that the proposed

Consultant(s) have the following additional skills and experience:

Qualifications:

• Experience: 5+ years of experience in technical writing, ideally with experience in government or complex, regulated environments.
• Technical Expertise:
• Proficiency with documentation tools such as Confluence and GitHub, and experience with API documentation and version control.
• Familiarity with software development processes and workflows, including Agile methodology, to document procedures and architecture accurately.
• Knowledge of security and data compliance standards, with the ability to document procedures ensuring compliance and risk mitigation.
• Skills:
• Exceptional written and verbal communication skills, with an ability to translate technical content into accessible documentation for diverse audiences.
• Ability to create clear, concise, and structured documentation, including system architecture, API guides, and training materials.
• Strong organizational skills to maintain a consistent documentation structure, update schedules, and version control.
• Certifications (preferred): Certified Professional Technical Communicator (CPTC), ITIL Foundation, or relevant technical writing certifications.
  
  

The Contractor's responsibilities will include the following:

• Develop and maintain high-quality documentation, including user guides.
• Standardize documentation practices and ensure they align with core team requirements.
• Support knowledge transfer activities to core team.
• Modernized, Scalable Technical & Web Architecture
• Sustainable Knowledge Transfer and Capacity Building
  
  

The Contractor's key activities will include the following:

• Create and maintain documentation, including API documentation, architecture overviews, and user guides.
• Develop a knowledge management strategy to ensure all documentation is current and accessible.
• Conduct training sessions or workshops to enable core team to manage and maintain systems.
• Work closely with developers, architects, and core team to document processes and workflows accurately.
  
  

The Contractor's key deliverables will include the following:

• System Documentation: Complete documentation covering architecture, APIs, user guides, and maintenance protocols (comprehensive technical and user documentation).
• Knowledge Transfer Materials: Training manuals, quick reference guides, and workshop presentations.
• Knowledge Management Strategy: A framework for maintaining up-to-date documentation and facilitating internal knowledge sharing.
• Ongoing Documentation Updates: Regularly updated documentation based on system changes and enhancements.
  
  

The project is a high-impact initiative that requires a systematic approach to implementing the recommendations from a recent external review of the MMI system. The appointed vendor(s) will deliver specialized resources to address key areas, including architecture, automated testing, user-centered design, and documentation, all within a collaborative, transparent framework. The resources will collaborate with the core team members throughout the project and will contribute to the achievement of the following outcomes:

Project outcomes will include:

• An architectural blueprint, risk assessment report, a proposed list of activities to March 31, 2025, in the first three weeks.
• Training sessions, knowledge transfer plans, and quick-reference guides for ongoing maintenance and development.
• A future-proof, scalable architecture for the MMI solution, ready to integrate current and future technology components.
• A fully operational CI/CD pipeline and an automated testing framework that ensures quality control, facilitates rapid deployments, and reduces errors.
• Complete and accessible system documentation that supports ease of use, maintenance, and knowledge transfer for internal teams.
• A design framework informed by user insights and research, ensuring the MMI solution aligns with the needs of end-users and enhances usability.
• Internal teams equipped to manage and maintain the MMI solution, reducing dependency on external vendors and ensuring long-term project sustainability.
• Modernize our approach and the underlying technologies that we use to deliver bespoke web and application services for program areas across government.