Contract \ Contract-to-Hire Contract technical writer – API docs, sample code, more
Job Description
I’m looking for a technical writer to deliver a completely new version of our REST API documentation, delivered via our public developer portal. The API lets developers upload audio files, and returns a machine transcript, a patented keyword/topic analysis, critical meta-data about the call, and optionally predictive analytics that look deep into the content of the conversation.
The current version is at https://apis.voicebase.com/ for reference. The new version will be equally developer focused but more complete, more friendly, and much better written. This audience loves their API docs, and craves more.
Your job is to learn the API by using it and by talking to the developers, and then to put yourself into the shoes of a new developer and create the set of documentation that you yourself would wish to see. For this project, you are in charge of planning the structure, gathering the content, writing and editing, and getting it all checked into the source code control system properly. In other words, everything except writing the underlying code itself.
You are a very seasoned technical writer, with the concise and friendly tone that developers love. This project will be easy for you since you have been intimately involved in “soup to nuts” API doc projects before – probably many times. I’d love for you to be close enough to stop by the San Francisco office to interact with the developers, but it’s not a requirement; this job is open to candidates across the english-speaking world who work during US hours.
This is a single project for now. Hourly rate depends on experience and expertise. For the right candidate, it can quickly turn into a regular contract gig. We’re not quite large enough to need a full-time doc manager, but I’m sure we will eventually.