We look at the pros and cons of using the DITA standard, and the alternatives.
The technical communication Venn diagram laptop stickers we created have been very popular. We’ve ordered more of them, and we’ve created some new designs. The new stickers have quotations from some of the people we’ve interviewed on the Cherryleaf podcast.
The stickers should arrive by the end of the month. Like before, we’ll post them off to anyone based in Europe who wants them.
In our latest podcast, we provide advice on writing a CV for Technical Author vacancies.
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?
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.
- 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:
http://codewerdz.org/ Repository analytics for code and docs
Solr (Search Engine)
Why we use a ‘docs as code’ approach for technical documentation Jen Lambourne, GDS, GOV.UK
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.
- 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/
In this podcast, we look at the job of a Technical Author/Technical Communicator, and how you can start your career.