API documentation: the undiscovered country

Recording from UAEurope 2017 conference.

With many software developers now spending their time developing APIs, there’s an increasing demand for API documentation writers.

It’s a fast changing field, with emerging information design patterns and authoring tools. It’s also different from end user documentation, and this means many Technical Communicators are uncertain if and how they should migrate to these roles.

  • what is an API and what is API documentation?
  • the role of an API documentation writer, and how it differs from mainstream Technical Author roles
  • the skills you need as a writer of API documentation
  • becoming an API documentation writer.

REST API documentation training course:

http://cherryleaf.teachable.com/p/documenting-rest-apis

Technical writing as public service – Video

Here is a link to a recording of an interesting presentation from Britta Gustafson on aspects of working on documentation in the US Government.

“What if U.S. federal agencies decided to reuse and contribute to open source software projects built by other agencies, since agencies often have similar technology problems to solve? And what if they hired technical writers with open source community experience to write documentation for these projects? That would be pretty cool. Also, that’s my work.”

Technical writing as public service: working on open source in government

 

Cherryleaf presentation on creating effective content

Just a reminder that Cherryleaf’s Ellis Pratt will be speaking at the Institute of Directors’ June 2015 Members Masterclass on “The written word – creating effective content”.

The written word is one of the key ways we communicate with others. Whether we’re telling or selling, it’s important we get our message across. Unfortunately, many people find writing time consuming, and it can often be difficult to get started on a new document.

In this session, we’ll look at some of the most effective techniques for creating the types of content created in today’s business world. You’ll discover some of the approaches used by professional technical communicators, copywriters and report writers.

Some of the issues we’ll look at include:

  • Clarity and persuasiveness
  • Getting started and organising your thoughts
  • How to structure documents
  • Getting to the point and being concise

This session is ideal for managers, engineers and other professionals interested in effective approaches to communicating more clearly and effectively in writing.

The IoD invites IoD Members and non-members to share their expertise and knowledge with other members. It will be held at 116 Pall Mall, London, on the 2nd June (18:00 – 21:00).

See:

The written word – creating effective content.

Institute of Directors masterclass on: The written word – creating effective content

Cherryleaf’s Ellis Pratt will be speaking at the Institute of Directors’ June 2015 Members Masterclass on “The written word – creating effective content”.

IOD building

The written word is one of the key ways we communicate with others. Whether we’re telling or selling, it’s important we get our message across. Unfortunately, many people find writing time consuming, and it can often be difficult to get started on a new document.

In this session, we’ll look at some of the most effective techniques for creating the types of content created in today’s business world. You’ll discover some of the approaches used by professional technical communicators, copywriters and report writers.

Some of the issues we’ll look at include:

  • Clarity and persuasiveness
  • Getting started and organising your thoughts
  • How to structure documents
  • Getting to the point and being concise

This session is ideal for managers, engineers and other professionals interested in effective approaches to communicating more clearly and effectively in writing.

The IoD invites IoD Members and non-members to share their expertise and knowledge with other members. It will be held at 116 Pall Mall, London, on the 2nd June (18:00 – 21:00).

See:

The written word – creating effective content.