Technical Writer 0406-0716

Description

**Background Information**

To develop this essential documentation, we are seeking a Senior Technical Writer with proven experience in healthcare IT and Application Programming Interface (API) documentation.

**Must haves**:

- A minimum of seven (7) years of continuous experience in creating technical documentation for complex software integrations, Application Programming Interface (API) specifications, or system implementation guides.
- 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.
- Proficiency with diagramming tools for creating workflow visuals (e.g. sequencediagram.org, Lucid chart, Visio).
- Excellent verbal and written communication skills, with proven ability to collaborate effectively with technical teams and stakeholders.

**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.
- 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.

**Required Skills**:

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

**Required Experience / Evaluation Criteria**:

- 7+ years of experience creating comprehensive technical documentation for software integrations, API specifications, or system implementation guides**:35 points**:

- Demonstrated experience working with API's and OAuth/OIDC service**:15 points**:

- Demonstrated experience and knowledge of healthcare data standards, specifically FHIR and SMART on FHIR**:5 points**:

- Proficiency with diagramming tools (e.g., sequencediagram.org, Lucidchart) to create effective workflow and architecture visuals**:10 points**:

- Excellent verbal and written communication skills, with demonstrated ability to collaborate effectively with technical teams and adapt to changing requirements**:10 points**

Total evaluation criteria: 100 points

Deliverables

**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.

**Knowledge Transfer Details**:

- The resource will ensure full knowledge transfer is provided to the Ontario Health team before end of engagement. Some of this might occur at the end of the engagement but will also be shared as information is obtained/consolidated. Key deliverables will be shared with team.
- The resource must provide all related documentation as part of knowledge transfer protocol. Documents will be reviewed by the appropriate leads and signed off by manager/director.
- The resource will work collaboratively with the Ontario Health team throughout the assignment and ensure key deliverables, milestones, and documentation are shared.
- A walkthrough of any demos, development, etc. will be required before the end of the engagement.

**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+