Want to see what kind of software docs engineers celebrate?

I see posts on LinkedIn all the time about training in writing API docs or how best to document software systems. Here in Silicon Valley, it’s the hottest sub-discipline in techcomm. In fact, API docs are so popular, they have an API Docs training class on the day before TC Camp at the end of January.

A while back, I saw a Facebook post by a software engineer in the SF bay area celebrating a website of Linux software documentation. He remarked that the docs were “excellently done,” a model for software docs everywhere to emulate. Continue reading “Want to see what kind of software docs engineers celebrate?”

12 tips from UX designers that Techcomm folks should know too

Next to API docs, UI/UX is one of the fastest growing sub-domains in technical writing. Not surprising, because documentation contributes to the user experience and explain how to use a product’s user interface.

In May, I spotted an article by Robert Hoekman, Jr. that I’ve now read several times. He called it a “UX Reality Check” for designers. It’s easy to get distracted by your product and forget to look at the world through your user’s eyes.

As I read through, several points stood out as being just as applicable to technical documentation. Here are the bullet points from the article that stood out to me the most. Continue reading “12 tips from UX designers that Techcomm folks should know too”

What is the best for DITA authoring and publishing tool?

I see this question posted all the time – in newsgroups, in blog comments, in LinkedIn groups. Posting this kind of question will get you one of three classes of answer. And every time, the answers posted are wrong.

Continue reading “What is the best for DITA authoring and publishing tool?”