The DocOps Trend: Applying Agile and DevOps to Technical Documentation
I bring an excerpt of this article to you courtesy of Will Kelly, as I think it brings to you methods and experiences from other technical writers around the world. You may view the original article here.
The advances and benefits in Agile programming and Agile project management are making headlines and grabbing a lot of attention these days. But what about technical documentation? Continue reading “The DocOps Trend”
Tech employees over age 55 are actually less stressed using technology in the workplace, and better at using multiple devices than their younger peers.
Continue reading “Myth busted: Older workers are just as tech-savvy”
Software User Documentation is often a last minute effort to deliver your software product and get it out the door. Your development team had a long list of requirements, so the documentation sometimes gets downsized in importance or it is sometimes neglected completely.
Continue reading “10 tips for Software Development managers about user documentation”
As usual, I bring this article to you courtesy of JACQUIE SAMUELS, as I think it adds relevance to what I am setting out to achieve with my documentation framework. You may view the original article here.
Documentation is (sadly but understandably) often the last push in the great effort to get a product out the door and into the hands of your customers. Because it’s the last thing on a long list of release requirements, it sometimes gets downsized in effort or time or neglected completely. At the heart of the matter, companies feel like shirking on their documentation deliverables is a possible solution to time and budget crunches. They feel this way because they consider documentation as an add-on to the product, an extra bit of service provided to customers but not an essential component of the product itself.
Guess what: That’s not how customers see it.
Continue reading “How out-of-date documentation can cost you”
I bring this article to you courtesy of Dennis Crane, as I think it adds relevance to what I am setting out to achieve with my documentation framework. You may view the original article here.
Nobody reads help files!
Are you sure?
In the ten years that we’ve been developing Dr.Explain, a leading-edge tool for creating help files, we saw hundreds of our customers’ projects. Our technical support team mostly receives user documentation for software products with requests to help implement some tricks. When talking with our customers, we ask them all kinds of questions about their projects, business areas, products, and audiences.
Based on that experience, we can draw a lot of conclusions, including this one: Users do read user documentation. In many cases, users frequently consult with such documentation. In some projects, it is a vital component of the product or services.
However, sometimes people do not use user documentation. In most cases, the reasons are as follows.
Continue reading “16 Reasons Why Your Users Do Not Read User Documentation”
I bring this article to you courtesy of Ellis Pratt, as I think it adds relevance to what I am setting out to achieve with my documentation framework. You may view the original article here.
Technology has changed enormously over the last 70 years. But have technical communication standards kept up sufficiently to reflect these changes? It appears that some of the most successful software companies are breaking generally accepted best practice in technical writing – a trend that clearly should get us thinking.
If you were going back in time twenty or twenty five years and found yourself in a classroom learning about technical writing, you’d probably find it was almost identical to classes on this subject offered today. Technical communicators tend to assume that technical communication best practices, which have been taught for the past 25 years, and even further back in time, are still appropriate today.
Continue reading “The changing nature of content”
I bring this article to you courtesy of Ron C Johnson, as I think it adds relevance to what I am setting out to achieve with my documentation framework. You may view the original article here.
As you might expect, technical writing is not just about writing. Certainly writing is a core skill, but depending on the job, the industry, and the purpose of the writing, a technical writer may wear many hats. Often tech writers’ responsibilities touch on editing, graphics, photography, formatting, marketing, training, designing, and document management/control, just to name a few. Continue reading “Ten things Clients should know about Technical Writing”
I bring this article to you courtesy of Jacquie Samuels, as I think it adds relevance to what I am setting out to achieve with my documentation framework. You may view the original article here.
GREAT DOCUMENTATION CAN SAVE YOU BIG BUCKS WHEN IT COMES TO SUPPORT BY JACQUIE SAMUELS
Let’s get back to the basics for a moment. Technical documentation has many diverse drivers, but ultimately, it all strives to perform one function: assist users so they can do what they want to do with the product. Sometimes they already know what they want to do, other times the documentation helps educate them.
Continue reading “Great documentation saves money”