The Spring 2015 edition of Communicator magazine and its special supplement on the Value of Technical Communication was entered in both the IoIC (Institute of Internal Communications) Awards in 2015 and the APEX Awards in 2016. One of Ellis’ articles (“Creating videos: tips and tricks”) was part of that issue.
We’ve just learnt this issue has won an APEX Grand Award. This is the first time Communicator has won a Grand Award. It has also won an IoIC Award of Excellence in 2015.
“This clean, appealing layout offers attractive spreads, a crisp, legible type schedule, with effective use of callouts, sidebars and captions. Content is equally exceptional, with fully vetted, well written articles on a wide range of professional topics. And the supplement on the value of technical communication is an effective ‘selling tool’ for managements and other key audiences. This magazine is precisely the kind of first rate publication you’d expect from a professional association of scientific and technical communicators.”
I’ve been on the road speaking at a conference this week, and I’ve been listening to a lot of presentations on technical communication. Many of these were on the importance of having structured, semantic content when you are dealing with large amounts of content that needs to be translated into different languages and published in many different ways. All of these presentations put forward XML-based systems as the solution.
However, XML isn’t the only method for having semantic content. For example, AsciiDoc supports attributes, which can be used to add a semantic descriptions to headings, paragraphs and whole documents. You can use conditions in RoboHelp and Flare to categorise content. You can also store content in a database.
It’s sometimes useful to remember that XML isn’t the only way to semantic content.
Cherryleaf’s technical author basic/induction training course has been accredited by the Institute of Scientific and Technical Communicators since its launch. This accreditation has to be renewed every few years, which involves having the course is re-assessed by the ISTC’s accreditors. Earlier this year, we submitted the course for renewed accreditation, and we’ve recently received an email informing us the course has been approved again by the ISTC.
There are user documentation projects where we are asked to write in American English instead of British English, and generally this is a pretty straightforward exercise for us. However, when I speak at conferences in the USA, delegates sometimes ask me afterwards what I meant by a particular expression. For example, I was recently asked what I meant by “round the houses” and “cheesed off“.
There are a large number of subtle differences between the two versions of English, which has led to a number of very interesting blogs on this subject. In particular, Dr. Lynne Murphy’s Separated by a common language and Professor Ben Yagoda’s Not One-Off Britishisms blogs provide a fascinating insight into how words and expressions gain popularity. The Language Log is another blog worth reading.
If the move to a more conversational approach to technical writing grows in popularity, we may see these differences becoming a bigger factor in localis(z)ing to American or British English.
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
Following on from our post The Internet of Things – creating a user guide for a fridge door, we came across other ways to create e-ink digital user guides that could be attached to the door of meeting rooms, providing information on room bookings, using the equipment in the room etc.
The next public Advanced technical writing & new trends in technical communication classroom course will be held on Thursday 23rd June, at our training centre in central London (WC2R). We’ll be updating the content from last month’s course, to reflect the recent and upcoming developments at Microsoft.
The Language of Technical Communication book is a collaborative effort with fifty-two contributors defining the terms that form the core of technical communication as it is practiced today. Cherryleaf’s Ellis Pratt was one of the contributors.
Each contributed term has a concise definition, an importance statement, and an essay that describes why technical communicators need to know that term.