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.

AI and chatbots in technical communication – A primer

It seems likely artificial intelligence (AI) and AI-driven chatbots will play a key role in helping users in the future. So what does this mean for technical communicators and for User Assistance?

This podcast is based on an article we’ll be posting to tekom’s Intelligent Information blog. The article is currently out for review, and it should be published in the next two weeks.

The podcast has three chapters, or parts:

  1. What are chatbots?
  2. Making a chatbot
  3. What does this mean for technical communicators and for User Assistance?

See the Cherryleaf Podcast for podcasts on similar topics.

Book – Current Practices and Trends in Technical and Professional Communication

This week, the Institute of Scientific and Technical Communicators published a book, called Current Practices and Trends in Technical and Professional Communication. Cherryleaf’s Ellis Pratt is one of its co-authors.

book cover - Current Practices and Trends in Technical and Professional Communication

“Technical and professional communicators are experts in making complex systems and worlds understandable to those who need to access them. However, both the concepts we are communicating about and the tools we are communicating with are changing at a rapid pace. To communicate effectively, we need our own knowledge and understanding to remain current, identifying best practice and learning from the experience of others.

Current Practices and Trends in Technical and Professional Communication is a valuable source of collective knowledge from our community of practice. Experienced practitioners and innovators (from the UK and international) are sharing what they know for the benefit of both the communicator and the end user.

The topics in the book cover important issues affecting the work we do (including globalization, localization and accessibility), and the tools and processes we can use to resolve some of the issues we encounter. Changes in technology are described, and ways of harnessing that technology are identified, including both current and future possibilities.

Whether you work in relative isolation, as the sole technical or professional communicator in a multidisciplinary team, or with other technical or professional communicators, you will find plenty in this book that is thought-provoking, interesting and useful.”