|
|
Articles > Writing > Technical Writing
Click on the title of an article below to view the complete article.
|
Displaying Articles 1-8 of 8
Writing Helpful Help - A Minimalism Checklist
Author: Glenn Murray
User documentation is all too often written by programmers for programmers. It tends to focus on the product's features, rather than the user's tasks. Generally, programmers aren't in the ideal position to be writing user documentation...
Technical Writing for the Terrified
Author: Mike Kemp
Sometimes it may be beyond a companies or individuals budget to hire a professional writer to address their technical documentation. Although in an ideal world all technical documentation should be produced by a highly trained expert, unfortunately we do not live in an ideal...
Dont Forget That Manual!
Author: V. Berba Velasco
It may seem comical, but it's a surprisingly common situation. I've encountered many companies that don't provide any user manuals with their products. If they do, their manuals are often horribly incoherent, or else years out of date. It shouldn't happen, but it happens all the time...
The Top Five Mistakes That Companies Make with Regard to Technical Documentation
Author: V. Berba Velasco
I've seen it time and again. One of the most common weaknesses that I've seen in engineering companies-indeed, an almost universal fault-is the lack of proper technical documentation. Some would laugh this off as a minor detail; however, the repercussions are often severe. A company's entire future can be made or lost based on the amount of attention they pay to this issue...
5 Reasons People Like Technology White Papers
Author: Christine Taylor
good white paper is a paper that makes you look good. You look good when your white paper makes sense, when it's readable, when it concentrates on benefits and examples, and when it's easy to get. Here's why:..
Dreading the Writing Assignment? Outlines to the Rescue
Author: Christine Taylor
Writing technical articles is a challenge. There you sit, surrounded by reams of research, notes and interviews. Where do you start?...
6 Ways to Leverage Technical Articles
Author: Christine Taylor
Technology vendors often contribute bylined articles to trade journals. The articles are great exposure for these companies but they don't come cheap - the trades rarely pay for these articles but the vendors spend time and resources to assign pieces, write them, approve them and submit them...
The Value of Adding Images to Technical Documentation
Author: V. Berba Velasco
It's cliché, but true-a picture does paint a thousand words. This is an important message to remember when writing any sort of user documentation, such as an installation guide or an instruction manual. A document that makes judicious use of images and diagrams will be much easier to understand than one that is composed entirely of text descriptions... |
|
|
|
