Posted on November 4, 2020

Technical Writer for API Documentation

Location: US

  • Job type: Freelance
  • Budget Type: hourly
  • Price Per Hour: $40
  • Hours Per Week: 25
  • Experience: $ Entry
  • Job Flexibility: Freelance
  • Category: Writing,Software Development

RoadSync is an Atlanta-based, Series A startup that is seeking a freelance technical writer to write API documentation for our newest public API. This includes writing getting started content, technical overviews, SDKs, and other related documentation for developers consuming our API. This is a one-time project.


Our expectation is that you will get our API documentation off the ground by providing simple to follow documentation for the developers utilizing our API. Documentation will include how to get started with the API (installation, configuration, getting into test env), SDK\’s, core concepts, examples, and FAQ\’s. Our API will be an additional cost for our customers, so our documentation must reflect that.


Job Requirements:

Experience with Swagger/OpenAPI
Experience with successfully writing API & software documentation for developers
Great interpersonal & communication skills
Great time management skills

Bonus Points:

Experience with financial technology (payments & invoicing)
Past API documentation that you can share or demonstrate
Familiarity with Readme as a documentation tool

Here is a link to our existing documentation that we are looking to build out.

docs.apis.roadsync.com/

Here are some examples of what we\’re going for (not exact, but similar):

CANDIDATE REPLIES

Jefferson BIEN-AIME

Master of Science software engineer with 9 years of experience in the full software development lifecycle – from concept through delivery with strong programming principles across multiple platforms, who stays current across the technology, learns and masters them quickly and immerse himself in technical best practices and then rapidly using newly acquired skills on the enterprise.

US

Only the employer can view this information

Nana Thompson

Software engineer with a penchant of learning an applying new things!

US

Only the employer can view this information

Subscribe to get Incluzion updates