Technical Writer

Deliverables Include but not limited to:

The Senior Technical Writer will be accountable for the following milestone-based deliverables:

• Deliverable 1: Initial Draft Integration Guide: Complete first version within 4 weeks of start date, covering architecture, API specifications, app launch sequences, and conformance checklists with initial visual aids.
• Deliverable 2: Final Release-Ready Integration Guide: Polished, comprehensive guide incorporating feedback and fully compliant with Ontario Health standards, with finalized visuals and reference materials.
• Deliverable 3: Ongoing Revisions and Enhancements: Timely updates to the guide to reflect project enhancements, technical changes, and vendor feedback.
• Deliverable 4: Supporting Materials (As Required): Develop supplemental materials to accelerate vendor understanding, such as an onboarding presentation deck, an FAQ document, and a glossary of key terms, based on input from subject matter experts.

Responsibilities:

The Technical Writer will be responsible for the following key activities:

• Collaborating closely with HALO project architects, developers, and product owners to gather technical details and requirements.
• Authoring, structuring, and maintaining the comprehensive HALO Integration Guide.
• Creating clear visual aids, such as sequence diagrams and architecture overviews, to enhance technical understanding.
• Applying and ensuring consistency with Ontario Health's documentation standards, branding, and AODA accessibility guidelines.
• Managing version control and maintaining all documentation within the designated repository.
• Developing supplemental materials to support vendor onboarding and implementation

Desired Skills:

• A solid technical background with hands-on understanding of RESTful APIs, OAuth 2.0/OIDC, pub/sub and cloud-based architectures.
• Proven, practical experience with healthcare data standards, specifically FHIR (Fast Healthcare Interoperability Resources) and SMART on FHIR.
• Familiarity with FHIR profiles and FHIR Implementation Guide.
• Experience documenting systems deployed on Amazon Web Services (AWS).
• Knowledge of EMR systems and clinical workflow integration patterns.
• Understanding of privacy legislation (PHIPA) as it applies to healthcare IT solutions.
• Experience with documentation platforms like GitHub or Confluence.

Requirements:

Must haves:

• 7+ years of continuous experience in creating technical documentation for complex software integrations, Application Programming Interface (API) specifications, or system implementation guides.
• 7+ years Demonstrated ability to capture complex technical input from architects and developers and translate it into clear, structured, and user-friendly documentation for a technical audience.
• 7+Proficiency with diagramming tools for creating workflow visuals (e.g. , Lucid chart, Visio).
• 7+ years Excellent verbal and written communication skills, with proven ability to collaborate effectively with technical teams and stakeholders.

Required Skills:

• API Fundamentals (Rest, HTTP Methods),
• Integration Concepts,
• JSON, YAML, Postman, Confluence.

Required Experience:

• 7+ years of experience creating comprehensive technical documentation for software integrations, API specifications, or system implementation guides
• Proven ability to capture complex technical input from subject matter experts and translate it into clear documentation for a developer audience
• Demonstrated experience working with API's and OAuth/OIDC service
• Demonstrated experience and knowledge of healthcare data standards, specifically FHIR and SMART on FHIR
• Proficiency with diagramming tools (e.g., , Lucidchart) to create effective workflow and architecture visuals
• Excellent verbal and written communication skills, with demonstrated ability to collaborate effectively with technical teams and adapt to changing requirements.