Posts Tagged ‘Technical Writing’
Technical Book Review: "How to Write Usable User Documentation"
How To Write Usable User Documentation (Second Edition) by Edmond H. Weiss is a thoughtful book on technical documentation written by a professional who obviously knows his material very well. Yet, overall, from its content to its format, this is also a book that shows its age. Published back in 1991, many of the topics…
Read MoreWhat is “Optimal” and “Optimization” in Technical Communication?
© 2010 Ugur Akinci From time to time I see sample documents in which the terms “optimal” and “optimization” are not used correctly. Since it’s a term that’s frequently used, I’d like to address it for the benefit of those TCC readers who wrote to me asking for an explanation of the concept. For one…
Read MoreHow to Write About Circuit-Board DIP Switches
© Ugur Akinci DIP switches are electronic components frequently used on circuit boards (a.k.a. “motherboards”, “panels”, “control boards” or “controller boards”) to configure basic system behavior by keeping a circuit either open or closed, by default. Once you set the value of a DIP switch it remains the same until you change it manually. First…
Read MoreTechnical Book Review: Studying Engineering: A Road Map to a Rewarding Career
If you’re a parent with a high-school kid who is debating whether to become an engineer or not, say this to him or her: “Here, read this book first and then decide on whatever you want to be…” The book I’m referring to is STUDYING ENGINEERING: A Road Map to a Rewarding Career by Raymond…
Read MoreThe Hidden High Cost of Cutting Down on Documentation
© 2010 Ugur Akinci When times are rough, one of the first things companies try to cut back on is documentation. Some managers believe that if they fire a few technical writers and skip on user and installation manuals the company would make more profit. The reality could be just the opposite. The company may…
Read More
How to Write and Punctuate Measurements Correctly
How to write measurements correctly is a hot topic for technical editors and I suspect will remain so for eternity. Ultimately, there is no absolutely correct and absolutely-wrong way of writing anything. I’ve seen so many different writing guidelines and style books recommending so many different principles that I cannot in all good conscience be…
Read MoreHow to Write a Documentation Plan
Documentation Plan is one of the key documents in technical writing. When starting off a technical communication project, either as a freelancer or a payroll employee, you’d better start with a Documentation Plan to avoid any unnecessary complications and headaches down the road. Here are the ideal stages of any documentation project: 1. Write the…
Read MoreTechnical Book Review – "The User Manual Manual"
© Ugur Akinci The User Manual Manual : How to Research, Write, Test, Edit & Produce a Software Manual by Michael Bremer (Untechnical Press Books for Writers Series, 1999, 314 pp) is a useful text book to learn not only the techniques of producing a software manual but becoming more aware of the “organizational ecology”…
Read MoreHow to Avoid Information Overload in Technical Writing
Too much information can be as bad as too little information in technical writing. Too little information prevents us from understanding the context and relationships. For example: “The motherboard failed the temperature test.” Yes, but in what way? Did it fail in the lower temperature zone or the high end of it? How long did…
Read More
How not to Sacrifice Clarity to Simplicity in Technical Writing
Introduction Simplicity in technical writing is a mantra frequently repeated by trainers and writing instructors. You’ve heard it many times and in general, it’s true: “Write simply. Eliminate all unnecessary words and facts from your technical writing.” Plain language is of course what we all like. But there are always exceptions in life, including this…
Read More