The Solutions Documentation Specialist will report to the Senior Product Owner. The
successful candidate will be in charge of gathering, developing, editing, disseminating
and maintaining technical information, in the form of instruction manuals, user guides,
wikis and other supporting documents, to communicate complex technical information
about our products to clients, support and implementation staff, and other stakeholders.
-
Produce high-quality, relevant, and timely solutions documentation for various internal and external audiences.
-
Author, proofread, and edit written material as needed to ensure consistency of message in solutions documentation across departments.
-
Examine technical documentation with internal department stakeholders to determine the needs of end-users of the documents.
-
Create clear and easy-to-understand solutions documentation (user documents, online help, developer guides, blogs, manuals, internal and external facing marketing material, integration guides, reporting material, certification material, etc.). Methodologies include:
-
Organization: keeps the editorial calendar up to date and manages multiple priorities concurrently
-
Topical experience: principled in applying to all potential blog topics
-
Communication skills: frequently needing to collaborate with various people to produce the best possible content
-
Adaptability: adapting to writing and editing in a specific style and tone
-
Analytical skills: understanding and catering to the audience as comprehensively as possible, analyzing and interpreting sets of raw data (audience, technical data, blog structure)
-
Engage the audience: generating, researching, and pitching ideas for posts
-
Writing, editing, publishing, and promoting
-
Staying current on company and industry news, trends, and events for possible opportunities to create more substantial, engaging content
-
Analyze existing and prospective content, focusing on reuse and single-sourcing opportunities.
-
Proofread and revise online content according to product, business objectives, and platform requirements.
-
Determine and maintain solution documentation and content information architecture.
-
Comprehend complex technical concepts and translate them into engaging, user-friendly content—effectively solving for non-technical users.
-
Review existing Connexall documentation and recommend revisions for scope, format, and content; pay attention to details (e.g., document number, modifications, track changes, headers, footers, etc.) and follow industry standards.
-
Review product samples and talk with subject matter experts, including product designers and developers.
-
Select appropriate audience content style and graphic tools, user feedback, and technical writing methodologies to create forward-thinking content.
-
Determine specific content segments for potential cross-functional usability based on organizational and audience needs.
-
Notify product managers, the CSG group, and the marketing team on end-user insights to develop solution documentation and suggest updates.
-
Work with internal teams and individuals to understand products, integrations, and documentation requirements.
-
Collaborate with all stakeholder groups to ensure content achieves voice, breadth, consistency, and comprehensiveness of message.
-
Monitor metrics on documentation usage and subject matter expert feedback to prioritize current, concurrent, and future documentation.
-
Bachelor’s degree in Engineering, Computer Science, or related field required.
-
Excellent English written and verbal skills required.
-
Experience in healthcare or Connexall product knowledge is an asset.
-
Degree or experience in Journalism, English, or Communications considered an asset.
-
Minimum 2 years proven experience as a technical writer.
-
Ability to install, configure, and experiment with software platforms to replicate user experiences.
-
Strong ability to work collaboratively as part of a team.
-
Proven ability to quickly learn and understand complex topics.
-
Experience writing documentation and procedural materials for multiple audiences.
-
Skilled in prioritization and multitasking.
-
Proficiency in MS Office.
