API Documentation / Tech Writer | 191850 in Coppell, TX at Vaco

Date Posted: 11/8/2019

Job Snapshot

Job Description

API Documentation / Tech Writer | 191850

DETAILS

Location: Coppell, TX

Position Type: 2M Contract (w/ likely extensions and/or conversion to fulltime)

Hourly / Salary: BOE!

JOB SUMMARY

Vaco Technology is currently seeking an API Documentation / Tech Writer for a 2M Contract (w/ likely extensions and/or conversion to fulltime) located in Coppell, TX. The API Documentation / Tech Writer will write API Documentation for APU users, including API reference documents and developer guides, with an emphasis on technically accurate documentation bringing clarity for basic-to-complex processes. The API Documentation / Tech Writer will review documents written by developers and project managers for particular APIs and suggest changes and/or seek clarity to externalize the same documents. The API Documentation / Tech Writer will supplement developer documentation with relevant sample code to reduce grounds-up efforts of external developers. The API Documentation / Tech Writer will develop and use all types of content (workflows / process schematics, etc.) to simplify the users understanding of the Open APIs. The API Documentation / Tech Writer will use their knowledge of the needs of the developers and pass feedback internally to develop the next set of Open APIs.

REASONS THIS ROLE IS OPEN

  • All of the APIs are built as public.
  • Documentation does currently exist, but at a very basic and inadequate level.
  • Current Documentation:
    • Does not include example requests and example responses.
    • Does not provide adequate descriptions of endpoints and each field for those endpoints.
    • Does not include an introduction that explains how to use the API (how to auth, how errors are addressed, etc.).

JOB REQUIREMENTS

  • Technical Writing / Documentation (2+ years)
  • API Documentation in a SaaS and/or PaaS Environment (SaaS strongly preferred)
  • Workflow Tools / Process Schematics (knowledge)
  • REST API (knowledge) - Python / JavaScript / JSON / HTML, etc.
  • Writing / Proofreading Technology-Related Content
  • Exceptional Written / Verbal Communication Skills

Job Requirements

API, Tech Writer, REST, SaaS, PaaS, Python, JavaScript, JSON, HTML