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?”
If you work remotely, chances are you spend a lot of time on the phone, on web conferences, and virtual meetings. For you to be productive, the other end of the call has to be able to hear you clearly. There can’t be much in the way of background noise. You’ve got to be able to hear them. And the headset can’t be uncomfortable or you’ll be distracted to the point of missing important conversation.
When it comes to headsets, I’ve got SPECIFIC requirements
Continue reading “The Best USB Headsets for Audio and Web Conferencing”
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”