Technical Writing – 3 Easy Ways to Capture Screenshots for your Print and Online Technical Documents
Screen shots are a must if you are a technical writer authoring a software manual of any kind. Here are three easy methods to capture and use a screen shot that would increase your productivity and help your readers follow the procedural directions more easily. 1) If you use a Windows machine, press the Print…
Read MoreTechnical Writing – A Checklist For a Software Document Writing Project
© 2009-2010 Ugur Akinci Here is a general checklist that you might find useful to make sure your software documentation project does not miss anything: Do you have access to the software project’s Scope Document? Do you have access to the functional and marketing specs of the software project? Have you written a Documentation Plan…
Read MoreIs Technical Writing Really "Unnecessary"?
One sometimes hears the comment that technical writing is not only “boring” but “unnecessary” as well. Nothing can be further from the truth. Good technical writing at its best is INVISIBLE. You don’t even know it’s there and that scores of people have benefited from it. And at its most extreme, yes, good technical documentation…
Read More
Is Technical Writing "Boring" ?
One traditional complaint leveled at technical writing is that it’s “boring.” I obviously strongly disagree with that charge and I’ll explain why. Personal Disclosure But first a necessary personal disclosure: yes, I do love technical communication with a passion but that’s of course NOT the only thing in life that I like intensely. For example,…
Read More