Workshop on software documentation

On November 19th (yes, it’s a Saturday) I will give a full-day workshop on software documentation. The workshop will cover not only the tools but also the concepts, providing advice on how you can make your own software documentation stand out from the crowd.

The workshop will be organized by tekom in the city of Leipzig, so the language will be German. You can find more details on the tekom web site (in German).

Update: There have been so many registrations that we have scheduled a second session for November 20th (yes, this one is even worse: it’s a Sunday).

New version of the Technical Writers’ Companion available

For almost four years, the Technical Writers’ Companion has been providing authors of technical documentation with the expertise needed to create high-quality user assistance. Now the Companion has become even better:

  • Improved search makes finding particular content easier.
  • An advanced printing function makes it possible to print selected topics also on paper.
  • You can now adapt the font size of all texts according to your individual preferences.

In addition, the latest Version is fully responsive, which means that you can use it also on tablets and other mobile devices.

You can browse a free preview version of the Technical Writers’ Companion at http://www.indoition.com/en/products/companion-trial-english.htm

Web site modernized

The indoition web site has been a well-known resource for technical communicators for many years. While I have constantly updated the content, the web site design and the technology behind the site had become a bit outdated in recent times. Finally, this is over! Now you can enjoy responsive design, mobile-friendly navigation, HTML5, CSS3, the absence of Flash, improved search, better readability, and more.
By the way: The site was built with the help of a help authoring tool plus some extra JavaScript, CSS, and PHP. What other set of tools would you expect a technical communication professional to use? Using a help authoring tool not only helped me to further deepen my expertise on how to max out these tools. Using a help authoring tool also makes it possible to maintain this bilingual site very efficiently, and it makes it a breeze to publish parts of the content as PDF files as well.
Just take a look yourself: www.indoition.com

Tool and Web Guide updated

I have just added various new resources to the Tool and Web Guide. Also I have checked all existing resources and removed the obsolete ones. In total, the Tool and Web Guide now lists about 950 handpicked tools and web sites. Now I know why even a minor update like this took me three days to accomplish …

tekom presentation evaluated

At the annual tekom conference in November, I presented a session on the various tools and workflows that can be used for creating online help systems. tekom has now sent me the participants’ evaluation of the session. The result: The quality was clearly above the average quality level of all conference sessions 🙂

Thank you!

Presentation at Zwickau University of Applied Sciences

I have been invited to give a presentation on technical documentation and software documentation at Zwickau University of Applied Sciences on October 20. The goal of the presentation will be to give students of engineering and computer sciences an overview of how user-friendly documentation is designed, structured, written, and built. What a great opportunity to make more young people interested in this field!