Lead Writer - APIs and developer documentation

Technology Search Ltd
10 Feb 2019
10 Mar 2019
Contract Type
Full Time
Technical Writer - APIs and developer documentation

You’ll be part of a small technical communications team with plans to grow considerably over the next year.

As an API Technical Writer you’ll specifically be responsible for developer documentation - for APIs, data feeds, webhooks, and more. Integration to business systems is vital for our clients, so the developer experience we provide must be first-rate.

You’ll work with development teams and integration specialists throughout new feature development. You’ll take part in the design phase to help with consistency of terminology and structure, and you’ll write any help needed to support the feature, and create any other content required, such as tutorials, articles, guides, and so on. Your work will be really varied, so personality and versatility are key.

The work is technical, so you must be comfortable writing about technical subjects.

Produce clear, easy-to-read, and consistent documentation and supporting content for REST APIs, data feeds, and webhooks.

Become a subject matter expert for the areas you work on.

Work closely with product owners, developers, and integration specialists.

Produce consistent screenshots and other visualisations when required

Review and proofread other writers’ work.

Contribute to the working methods and processes of the team.

Experience writing API and developer documentation.

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.

Proven experience of working with development and QA to write and deliver customer-facing documentation.

Ability to work independently to tight deadlines, across multiple projects simultaneously.

Desirable skills

Using static site generators such as Jekyll, and writing in Markdown

Using Git, or other version control systems

Similar jobs

Similar jobs