We’ve made a few changes to our online training courses, to make it easier to order and understand. There are now just three online courses: Technical Author/technical writing Advanced technical communication End user documentation writing skills for developers We’ve moved all the other courses we had previously into a single, advanced technical communication skills course…. Read more »
Category: Technical Writing
Don’t say “simply”
At this month’s WriteTheDocs London meetup, Jim Fisher of Pusher presented a talk called “Don’t say Simply“. He talked about words, such as “simply”, that can seem innocuous when written in user documentation, but which show a lack of sympathy when read. He showed how popular “simply” is with developer documentation writers, by showing the number… Read more »
Podcast: Books on technical writing
New training course – Writing skills for developers
Today, we’ve released our latest training course – Writing skills for developers. The course teaches developers the key skills of technical writing for software user documentation. Although it would be better for a professional technical communicator to write the end user documentation, for some organisations, this isn’t always possible. It is for developers who: Need a solid… Read more »
What is the minimal amount of user documentation you should write?
In researching what developers wanted to learn about writing documentation for users, the most common issue related to how much, or how little, they should write. One developer said: “I would want to know what is the minimum I should write. If you can persuade me what is the necessity of each thing I’m capturing, and… Read more »