Vacancy #4180 Senior Technical Author, Worcestershire, Up to £43K

Our client develops software to control machinery remotely, and it is looking for a Senior Technical Author to join its documentation team. You’ll be using RoboHelp to develop online Help and user guides for its software.

From time to time, you’ll be advising your colleagues, where appropriate, in producing documents efficiently. You may also need to research and implement new and better ways to assist users through technical documentation.

For more details, see: #4180 Senior Technical Author, Worcestershire, Up to £43K

Docs Like Code – Interview with Anne Gentle

Here is early access to the latest episode on the Cherryleaf Podcast – Interview with Anne Gentle, author of Docs Like Code and Product Manager at Cisco. It will be published on the podcast channel on Monday.

Topics covered:

  • What is docs as code?
  • Why do it?
  • When might this approach might be applicable?
  • The limitations
  • Docs like code in development sprints
  • Is it only for developer docs?
  • Do you you need to understand programming?
  • Why did you self publish?
  • The benefits of taking this approach
  • The future developments
  • Automating document builds

Links to topics mentioned:

Subscribe to Cherryleaf’s newsletter

Cherryleaf training course – Advanced technical writing techniques

https://www.docslikecode.com/

Conversation and Community: The Social Web for Documentation

Troy Howard Documentarian, Super Genius at Twitter

http://codewerdz.org/ Repository analytics for code and docs

Matt Fleming on Twitter

Docs Like Code GitHub repository

Jekyll

https://docs.openstack.org/pike/

WADL RAML OpenAPI

https://bitbucket.org/

http://docs.metacloud.com/

Liquid scripting

YAML

PrinceXML

Lunr Search Engine

Solr (Search Engine)

Why we use a ‘docs as code’ approach for technical documentation Jen Lambourne, GDS, GOV.UK

The Definition of Done

Learn Python the Hard Way

AsciiDoc

ReST

GitHub Flavoured Markdown spec

XML Press

REST API

Building Docs Like Code – article

Travis CI 

Jenkins

Circle CI

Webhooks

Bash scripts

An Introduction to Static Site Generators

GitHub Pages 

Cherryleaf online courses are now available via an iOS app

Subscribers to Cherryleaf’s online courses can now take them using their iPhone, iPad, or iPod touch, plus the Teachable iOS app.

Here’s how you can download the iOS app:

  1. Visit the Apple App Store on your compatible IOS device (requires iOS 9.3 or later).
  2. In the App Store, search for, “Teachable Online Courses”.
  3. Click the cloud icon to download the app on your device.
  4. After downloading, open the app.
  5. On the login screen, enter the email address and password associated with the student account you’d like to access. This is the same email address and password you use to log into our courses through the web browser on your computer.
  6. When you log in, you’ll see all the Cherryleaf school you’re account is associated with, along with the specific courses you’re enrolled in.

Training, accreditation and CPD in technical communication

Below is an interview with David Farbey of the Institute of Scientific and Technical Communicators, where we discuss training, accreditation and CPD in technical communication.

We cover:

  • Becoming a technical communicator is different from becoming a lawyer, doctor, developer or an accountant in that, in the UK, there is no standard career path from school. How does that affect the profession and starting a career?
  • What training, if any, do you need to be a technical communicator?
  • The ISTC’s Professional Development and Recognition
  • Certifying technical communicators
  • The ISTC certified courses
  • What does a undergraduate or post-graduate course offer someone?
  • Where does CPD fit into this?
  • What are we likely to see in the future with regards to training and certification?

See also: Cherryleaf’s ISTC accredited training course: https://www.cherryleaf.com/training/technical-author-basicinduction-training-course/