Lead Writer API & Dev Documentation

Recruiter
Technology Search Ltd
Location
Hatfield
Posted
06 Dec 2018
Closes
03 Feb 2019
Contract Type
Permanent
Hours
Full Time
Leading eCommerce technology company going through exceptional growth, is looking for a Lead Technical Writer for API's and Developer Documentation
Role:
This is a unique opportunity for a Lead Writer to be part of this technology company during an exciting phase in the company’s history.
We’re a multinational and multilingual workforce of about 1,000 people, operating in four European countries.
They are looking for a Lead Writer for API and developer documentation to join their growing technical communications team. They're going through a transformation at the moment - selling their platform to international clients - and they're looking for someone who is smart, adaptable, keen to learn, and across all the latest thinking in API documentation and the developer experience.
Their APIs, data feeds and webhooks are critical components of their platform that enable their clients to integrate their businesses with their solution. The documentation and developer experience they provide is central to making that a success.
They are looking for someone who is passionate about the developer experience - and the role content plays within it. You’ll know what content we need to provide and know how it should be structured, delivered, and presented. We’ll be looking to you to be engaged with the latest industry thinking and to bring back and implement the best ideas and approaches. We want to create a best-in-class developer portal to make it easy for our clients’ developers to find out what they need to know in order to build integrations with our platform.
While you’ll be responsible for the developer documentation within our Help and Learning Centre, you won’t be on your own - you’ll work alongside the documentation manager and be a key member of a growing team of writers. We’re building an extensive content portal covering developer documentation, end-user help, training, feature explainers and knowledge transfer. You’ll share and collaborate on best practices and ways of working so we grow as a team and develop our craft. You’ll help ensure any existing or new writers who might need to work alongside you on developer documentation do so in a consistent way.
Responsibilities:
As the Lead Technical Writer, you’ll be more than just a writer. You’ll work closely with development teams and integration specialists throughout new technical feature development. You’ll take part in design meetings to help with consistency of terminology and structure, you’ll write any help needed to support the feature, and create any other content required, such as tutorials, articles, guides, and so on.
You'll be required to learn how to use our software platform to an advanced level - and become a subject matter expert on all thing’s API, data and webhooks.
In summary, you’ll:
* Produce clear, easy-to-read, and consistent documentation and supporting content for REST APIs, data feeds, and webhooks.
* Become a subject matter expert for APIs, data feeds, webhooks and custom integrations.
* Work closely with product owners, developers, and integration specialists.
* Be confident being involved in the discovery and design phases of APIs and data feed specifications - advising on terminology and language.
* Know when to use visualisations alongside, or instead of words to get your point across (we have a graphic designer who can help us with illustrations we need).
* Review and proofread other writers’ work.
* Contribute to the working methods and processes of the wider technical communications team.
Skills Required:
* Experience writing API and developer documentation.
* Knowledge of different solutions for generating API documentation.
* Technical knowledge about how APIs are built, and how they’re used by clients.
* Impeccable written English, and the ability to write consistently and concisely in accordance with a style guide.
* The ability to write easy-to-read, fluent text in plain English, and the capability to organise content clearly.
* Ability to work independently to tight deadlines, across multiple projects simultaneously.
Desirable:
* Using static site generators such as Jekyll, and writing in Markdown.
* Using Git, or other version control systems

Similar jobs

Similar jobs