API Technical Writer - Remote
Job Description As an API Technical Writer at Medable, you will work in a fast-paced environment on an Agile team of backend writers creating internal- and external-facing developer documentation. You will enjoy working hard while having fun as part of a team of writers who support and encourage each other all day, every day. You will use and document state-of-the-art tools and systems to help us change how the world conducts clinical trials. You should have familiarity with using and following a style guide and have strong written and verbal communication skills. The best candidate for this position (that's you!) will:
Align with Product and Engineering leaders to match content with upcoming releases Plan, track, and deliver documentation projects Outline, draft, ask questions, test, fail quickly, and learn & improve, and iterate Independently follow style guidelines and writing standards to develop and deliver how-to, SDK, and API reference docs for developers Understand minimalist writing and have a tight writing style Self-edit and maintain high standards for your content, while welcoming input, corrections, and suggestions from both your peers and the editing team Create diagrams and other engaging content to help best explain concepts and workflows Use HTTP clients like Postman to research and test API queries Craft and maintain sample/example code in Java, Javascript, Objective C, JSON, NodeJS, and others Develop relationships across the organization, including Engineering, Product, CS, QE/QA, and Training, among others Qualifications 5
years creating excellent content for a developer audience, including API and SDK reference topics, developer guides, tutorials, and other content (work and school years can be combined to help you meet that 5-year threshold, if applicable) Bachelor's or Master's degree in English, Technical Writing, Computer Science, or Information Systems, or related field Ability to create basic code examples in one or more current programming/scripting languages such as Java, JavaScript, and Objective C, working alongside engineering teams Ability to thrive in a fast-paced, ever-changing startup-style environment, working both on a team and independently Experience with:
REST and Java APIs, Git, Agile environments, Confluence, and developer workflow tools such as Jira Authoring using one or all:
XML/DITA, Markdown, minimalism, CCMS, or Salesforce Knowledge OpenAPI/SwaggerUI DBs and related technologies such as Postgres, MySQL, or MongoDB Proven ability to handle multiple priorities in a fast-paced, constantly evolving environment Proven track record of delivering high-quality documentation on deadline Experience with or knowledge of one or more of the following:
REST and Java APIs Java, JavaScript, and Objective C Github and GitBook Confluence and Jira XML/DITA, Markdown, minimalism, CCMS, or Salesforce Knowledge OpenAPI/SwaggerUI DBs and related technologies such as Postgres, MySQL, or MongoDB Bonus points:
Previous experience working in the DCT, clinical trial, or health care industries Experience working on teams in the squad model.
Salary Range:
$80K -- $100K
Minimum Qualification
Technical Support, Technical Product Management, Software DevelopmentEstimated Salary: $20 to $28 per hour based on qualifications.
Align with Product and Engineering leaders to match content with upcoming releases Plan, track, and deliver documentation projects Outline, draft, ask questions, test, fail quickly, and learn & improve, and iterate Independently follow style guidelines and writing standards to develop and deliver how-to, SDK, and API reference docs for developers Understand minimalist writing and have a tight writing style Self-edit and maintain high standards for your content, while welcoming input, corrections, and suggestions from both your peers and the editing team Create diagrams and other engaging content to help best explain concepts and workflows Use HTTP clients like Postman to research and test API queries Craft and maintain sample/example code in Java, Javascript, Objective C, JSON, NodeJS, and others Develop relationships across the organization, including Engineering, Product, CS, QE/QA, and Training, among others Qualifications 5
years creating excellent content for a developer audience, including API and SDK reference topics, developer guides, tutorials, and other content (work and school years can be combined to help you meet that 5-year threshold, if applicable) Bachelor's or Master's degree in English, Technical Writing, Computer Science, or Information Systems, or related field Ability to create basic code examples in one or more current programming/scripting languages such as Java, JavaScript, and Objective C, working alongside engineering teams Ability to thrive in a fast-paced, ever-changing startup-style environment, working both on a team and independently Experience with:
REST and Java APIs, Git, Agile environments, Confluence, and developer workflow tools such as Jira Authoring using one or all:
XML/DITA, Markdown, minimalism, CCMS, or Salesforce Knowledge OpenAPI/SwaggerUI DBs and related technologies such as Postgres, MySQL, or MongoDB Proven ability to handle multiple priorities in a fast-paced, constantly evolving environment Proven track record of delivering high-quality documentation on deadline Experience with or knowledge of one or more of the following:
REST and Java APIs Java, JavaScript, and Objective C Github and GitBook Confluence and Jira XML/DITA, Markdown, minimalism, CCMS, or Salesforce Knowledge OpenAPI/SwaggerUI DBs and related technologies such as Postgres, MySQL, or MongoDB Bonus points:
Previous experience working in the DCT, clinical trial, or health care industries Experience working on teams in the squad model.
Salary Range:
$80K -- $100K
Minimum Qualification
Technical Support, Technical Product Management, Software DevelopmentEstimated Salary: $20 to $28 per hour based on qualifications.
|
|
 | |
