November 14, 2017

If not DITA, then what?

We look at the pros and cons of using the DITA standard, and the alternatives.

 

Every Page is Page One - Interview with Mark Baker at UAEurope 2017

Interview with Tony Self - UAEurope 17

00:0000:00
October 30, 2017

Books on technical writing

We look at some of the best books to read on technical writing.

 

Single Sourcing, Kurt Ament

Ron Blicq and Lisa Moretto

Minimalism Beyond the Nurnberg Funnel, John Carroll

Lean for Practitioners, Mark Eaton

Managing Your Documentation Projects, JoAnn Hackos

Information Development, JoAnn Hackos

Modern Technical Writing, Andrew Etter

Docs Like Code, Anne Gentle

Current Practices and Trends in Technical and Professional Communication, Stephen Crabbe

The Language of Technical Communication, Ray Gallon

The Language of Content Srategy, Rahel Bailie

Every Page is Page One, Mark Baker

Automate the Boring Stuff with Python, Al Sweigart

Don't Make me Think, Steve Krug

Rocket Surgery Made Easy, Steve Krug

Content Strategy: Connecting the Dots Between Business, Brand, and Benefits, Rahel Bailie and Noz Urbina

Content Design, Sarah Richards

00:0000:00

Advice on writing a CV for Technical Author vacancies.

Links:

Europass

Cherryleaf - how to register as a candidate

Top 25 Content Experience Influencers 2017

00:0000:00

We explore these questions from listeners:

  • What’s your opinion of Zendesk and Mindtouch? Someone in our company thinks it might be a good idea to explore the idea of moving our Help content  – have you heard of anyone doing this and then using it in a way of single sourcing etc? 
  • Our boss wants us to consider the idea of merging our Help content and our “Knowledge base” which is like articles/support troubleshooting etc. Whether this is our content going into the knowledge base or vice versa, we’re not sure in terms of direction. Do you have any opinions on merging article-based content like this into a Help Authoring tool or Help content into a “normal” website like that?

Links

Just-In-Time Documentation: A Practical Guide to Agile Documentation

AI and chatbots in technical communication - A primer

Cherryleaf

00:0000:00

Interview with Anne Gentle, author of Docs Like Code and Product Manager at Cisco. 

Interview by Ellis Pratt, Cherryleaf

Subscribe to Cherryleaf's newsletter

Cherryleaf training course – Advanced technical writing techniques

For comments and feedback: info@cherryleaf.com

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:

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 

00:0000:00

Interview with David Farbey of the Institute of Scientific and Technical Communicators, about training, accreditation and CPD in technical communication.

We discuss:

  • 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?

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

ISTC website: www.istc.org.uk

David's email: education@istc.org.uk 

00:0000:00

We look at the job of a Technical Author/Technical Communicator, and how you can start your career.

 

www.istc.org.uk

Cherryleaf’s online Technical Author/technical writing course

00:0000:00

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?

Part 1 - What are chatbots?

Part 2 - Making a chatbot

Part 3 - What does this mean for technical communicators and for User Assistance?

 

About the speaker

Ellis Pratt is a Director at Cherryleaf, a technical writing services and training company based near London.

He has over 20 years of experience working in the field of documentation, has a BA in Business Studies, and is an Associate of the Institution of Engineering and Technology. Ellis is contributor to two books on technical communication. He is also on the management council for the Institute of Scientific and Technical Communicators (ISTC), the professional body for technical communicators in the UK.

Contact information

https://www.cherryleaf.com

info@cherryleaf.com

More information

Primer article - https://www.cherryleaf.com/blog/wpress/wp-content/uploads/2017/08/AI-and-chatbots-in-technical-communication-article.pdf

https://www.cherryleaf.com

https://www.cherryleaf.com/blog

http://intelligent-information.blog/en/

http://intelligent-information.blog/en/blog/2017/07/28/from-ua-reloaded-amplify-the-intelligence-of-your-users-and-your-company/

 

https://tryolabs.com/blog/2017/01/25/building-a-chatbot-analysis--limitations-of-modern-platforms/
https://chatbotsmagazine.com/which-are-the-best-intelligent-chatbots-or-ai-chatbots-available-online-cc49c0f3569d
https://chatbotsmagazine.com/the-complete-beginner-s-guide-to-chatbots-8280b7b906ca
http://contentrules.com/computing-in-the-age-of-cognitive-systems/
https://www.linkedin.com/pulse/6-trends-ai-assisted-chatbot-service-market-mila-d-antonio
https://cloud.google.com/natural-language/
https://aws.amazon.com/amazon-ai/
https://aws.amazon.com/lex/
https://www.slideshare.net/InfoDevWorld/engineering-content-for-bots-ai-and-marketing-automation-cruce-saunders
https://www.slideshare.net/InfoDevWorld/feeding-the-bots-preparing-product-content-for-the-intelligent-assistance-revolution-with-joe-gelb

 

Robot image https://commons.wikimedia.org/wiki/File:Robot-clip-art-book-covers-feJCV3-clipart.png From From Wikimedia Commons, the free media repository.

00:0000:00

The UK Parliament is one of the oldest organisations in the world. So how do you deliver a strategy to a body that has over 700 years of content? Cherryleaf's Ellis Pratt interviewed Rosie Hatton, Strategy Digital Lead at the Parliamentary Digital Service, to find out. 

 

Topics covered:

  1. What is Parliament? 1'56"
  2. The content Parliament creates. 3'38"
  3. What is the PDS? 5'08"
  4. The I AM PARLIAMENT programme. 9'00"
  5. The PDS's digital strategy framework, its assumptions and principles. 10'18"
  6. Having an open and agile digital culture in a traditional organisation. 13'08
  7. Working in a continuous interative process. 20'45"
  8. Sharing ideas with the Government Digital Service. 25'24"
  9. Where does the PDS's content strategy fit within its digital strategy? 28'22"
  10. Tracking the impact of changes to laws on other laws. 37'01"
  11. The similarities between PDS and Open Source software projects. 41'55"
  12. Crowdsourcing a digital strategy. 43'30"
  13. Benefits management. 44'00"
  14. How to manage and sell change. 47'50"

Links:

www.cherryleaf.com/blog

Parliamentary Digital Service blog

http://www.parliamentlive.tv/Commons

https://pds.blog.parliament.uk/strategy-in-action/

http://www.parliament.uk/mps-lords-and-offices/offices/bicameral/parliamentary-digital-service/digital-strategy-for-parliament/

http://www.data.parliament.uk/

https://khub.net/ (knowledge hub)

 

People:

https://twitter.com/rosiehatton

https://twitter.com/ellispratt

https://twitter.com/DigiBungalow

https://twitter.com/mattstutely

https://twitter.com/digiminster

https://twitter.com/_allenemma

https://twitter.com/Rob_Greig

 

00:0000:00

This is a recording of a 2012 webinar called "Recruiting the right Technical Author". 

For more details on Cherryleaf's contract and recruitment services, see https://www.cherryleaf.com/recruitment_services/

 

For comments and feedback: info@cherryleaf.com

00:0000:00

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

 

For comments and feedback: info@cherryleaf.com

 

00:0000:00

Reviews of two presentations at the UAEurope 17 conference.

Kristof Van Tomme (Pronovix). Software support and Artificial Intelligence.

Pawel Kowaluk (3di Poland). Knowledge Feed: Make your Online Help More Like Facebook

Interspersed with interviews from at the UAEurope 2017 conference: 

Dr Tony Self. HyperWrite

Willam van Weelden. Adobe

Mike Hamilton. MadCap Software.

 

With thanks to Matthew Ellison

http://www.uaconference.eu/

 

Interviews by Ellis Pratt, Cherryleaf

Links:

Documentation as an API – the docsbot

The T-Bot: A new Help model from Microsoft

The Impact of "Ambient Findability"

 

For comments and feedback: info@cherryleaf.com

00:0000:00

Load more