The Quirker website has spotted that someone at Apple has subtly inserted a “Rickroll” into the Apple Watch documentation. Can you see it in the image below?
Stack Overflow, a collaboratively edited question and answer site for programmers, has announced its plans to add documentation to the site:
“Lately we’ve been asking ourselves “what else could we do to improve developers’ lives on the internet?”. Jeff’s original announcement of Stack Overflow said this:
There’s far too much great programming information trapped in forums, buried in online help, or hidden away in books that nobody buys any more. We’d like to unlock all that. Let’s create something that makes it easy to participate, and put it online in a form that is trivially easy to find.
Stack Overflow has made all of that a lot better, but there’s one area that is still hanging around: Documentation. Just like Q&A in 2008, Documentation in 2015 is something every developer needs regularly, and something that by most appearances stopped improving in 1996. We think, together, we can make it a lot better….
…We’re hoping we can improve documentation, not just move it under the stackoverflow.com domain.”
It will be fascinating to see how this project progresses – what issues they encounter, how they tackle these, and if the solutions work.
We’re moving our public classroom course on Trends in Technical Communication Course – Advanced Technical Writing Techniques from the 18th September to Tuesday 22nd September. There are places available if you’d like to book.
We’ve also run this course a number of times during the summer as an “onsite” course for clients, using WebEx and Lync (soon to be called Skype for Business). Using online meeting technologies like these means we can deliver training to authoring teams throughout the world.
We have been asked if individual delegates overseas could use these platforms to participate in our public, classroom, course. I’m afraid we don’t offer this. The “online meeting” courses involve using special lighting and audio equipment that isn’t available in the training rooms we use for the public courses. Also, it would be very difficult for the trainer to manage two different delivery methods simultaneously.
This weekend, we went to the Fabularium on London’s South Bank, where the programme highlighted The Museum of Almost Forgotten Things. It struck me that this concept could also be applied to technical communication. The impetus to write things down, to document policies and procedures and to write user documentation for software written in a Sprint, is often due to organisations worrying that important information might be soon forgotten. Technical Authors often capture and record almost forgotten things. They might, however, object to the word “museum”, because they are working with how things are today much more than how things were in the past. So perhaps “palace” could be an alternative word to use.
Ben Haggerty, the storyteller whom we saw perform, started by trying to discover who we, the audience, were. He quoted a west African saying that there are four types of people in the world:
Those that know and know that they know. These are called teachers, and should be respected.
Those that know, but don’t know that they know. These people are asleep.
Those that don’t know, and know they don’t know. These people are students.
Those that don’t know, but don’t know they don’t know. And there are 630 of them sitting in the House of Commons on the other side of the Thames.
It’s interesting to see how close this old African saying is to competency models used in training today: unconscious incompetence, conscious incompetence, conscious competence and unconscious competence.
Google’s Riona MacNamara presented at the Write The Docs North America conference on “Documentation, Disrupted: How Two Technical Writers Changed Google Engineering Culture“. In the video of the presentation below, Riona explains how she worked with a small team of writers and engineers to build a documentation platform in six months that is becoming a part of the standard Google engineering workflow.
We thought it would be useful to reflect on our plans for topics and courses in technical communications. In the past, some of the best suggestions have come from customers and prospects; it’s great to pick up useful ideas from others.
Today, you’ll find classroom or elearning training courses in:
- Technical writing (Technical Author/Technical writing Basic/Intermediate and Advanced technical writing techniques)
- Managing and planning technical documentation projects (Embedded Help writing strategies, Introduction to content strategy and Single sourcing and content reuse)
- DITA (DITA Basic/Intermediate, plus ad-hoc classroom courses in DITA planning and DITA publishing)
Our current thinking is to offer more topics around managing and planning technical documentation projects. In the past, we’ve offered an course on estimating projects. We also know managing project time is another important topic. Perhaps there are other topics that would fit under this category?
There’s also the issue of which courses should be online (recorded) courses, and which ones should be classroom-based (live) courses. Delegates say really like the two training venues we use in central London (we struck gold there), but online courses enable people to take a course pretty much anywhere and at any time.
If you have any thoughts, you can email us your thoughts, or you can use the comment box below.
Whenever Apple launches a new product range, there’s a great deal of buzz and excitement. There’s lots of speculation as to how the technology could be applied by different professions and by consumers. Yesterday’s launch of the Apple Watch was no exception.
The title of this post may give away the fact that this post contains wild guesses. We may well look back on in five years time and ask, what were we thinking?
Cherryleaf has been working on a project which shows people how to teach non-readers to read. We’ve been working with Elizabeth Ainley, who has written a book, go for it!, which can be used to teach illiterate and/or dyslexic adults.
Elizabeth asked Cherryleaf to help her re-write the existing instructions aimed at the adult coaches who will be using go for it! This involved making the instructions clearer, and clarifying the learning outcomes.
Schoolchildren in Sierra Leone have been the first users of the project. It means a 12 year old child who can read can now teach others. The school is run by Miriam mason-Sesay MBE for the Educaid, who sent Elizabeth these photos of the teaching materials in use: