API Technical Writer

Work from
Anywhere 🌎
Full Time
Opening date
Closing date
8 Feb 2022
We value your craft, and as our first API Technical Writer, you’ll have an opportunity to make an impact from Day 1. This role will take the API that Engineering produces and help drive adoption and self-service through robust documentation that meets the triad of developer needs: tutorials, examples, and references. You’ll also help us start a technical writing discipline at Redox and have a voice in early strategy and process for technical writing across the company. This role will be part of the FHIR API team and will work closely with our other teams who produce APIs.

As an API Technical Writer, you will:

  • Work closely with our Product, Engineering, and Customer Success organizations and available data to understand our current state and propose updates and improvements to existing and planned documentation
  • Collaborate with SMEs to create content across types of documentation, including quickstart and technical implementation guides
  • Support our engineering team in development of the API by creating tutorials, examples, reference documentation, and other resources as needed
  • Create a style guide and lexicon to support other Redoxers in updating and contributing to our documentation
  • Develop process for periodic review of existing documentation tools and updates related to new features
  • Create adoptable systems of organization that are intuitive to follow and easy to use for internal and external developers
  • Independently implement changes to improve the usability of our API docs
  • Focus on customer delight as you design new ways to abstract away layers of complexity when users don’t need it, making it readily available when they do
  • Help develop best practices and processes around customer-facing documentation
  • Consolidate content management tools and contribute to designed structure for technical documentation in these tools

To be successful in the role, your experience should include:

  • 2+ years of experience in creating, implementing, or maintaining, technical tutorials, developer guides, quick-start guides, and reference documentation.
  • You have a basic understanding of API concepts and are familiar with JSON
  • You understand developers and adult learners. You are empathetic to developer’s needs and can translate complex technical concepts and workflows into elegant and delightful self-service content.
  • You are ready to jump in to help shape early process and strategy around a new discipline for the company
  • You employ curiosity as a primary problem-solving method and seek out and incorporate input from others.
  • You are data-driven and seek out information to help you prioritize work and understand the success of your projects.
  • You are committed to contributing to a respectful environment and are open to embracing our engineering values to help us continue to build a strong, inclusive engineering culture.
  • You are comfortable adhering to work standards and following change management processes (customers trust us with their Protected Health Information), and also will advocate for changes to improve our systems where appropriate.
  • You are able to thrive on a collaborative and fully distributed (remote since 2014!) team.

Nice to have skills but not required:

  • Experience or familiarity working with healthcare technology and workflows
  • Experience or familiarity with tools like cURL and Postman
  • Experience or familiarity with NodeJS or React
Report job · Embed widget

How to apply

Personalised job alerts

Set up personalised e-mail alerts about similar jobs.

Keyword: API Technical Writer

See a few more

Related jobs in Copywriting & Content

Job Widget Code

Place this code wherever you want the widget to appear on your page.

<script src="//jobicy.com/api/widget.js?5XyPbk5QqyZg=10207" async></script>

Job Search Safety Tips

Here are some tips to help you search and apply for jobs safely:
Watch out for suspicious jobs Don't apply for jobs that offer high pay for little work or offer to hire you without an interview.
Check the employer's profile Make sure you're applying for a trustworthy job by visiting the employer's profile and learning more about them.
Protect your information Don't share personal details like your bank account or government-issued ID on suspicious websites or messengers.
Report jobs that feel unsafe If you see a job that seems misleading, inappropriate or discriminatory, report it for going against our policies and we'll review it.

Share this job