Technical Writing
How to Write an Excellent Index
Introduction An index is an alphabetical list of subjects and page numbers that will help the reader find information in a textbook, journal article, or other publication. An index should be: – Alphabetized by the first word of the entry – Arranged so that words are grouped together by topic – Clearly labeled with…
Read MoreTwo Different Types of Technical (Software) Documents
In technical writing, there are two different but related types of software documents and I call them “Interface Manuals” and “Procedural Guides”. An INTERFACE GUIDE explains what each button, or the graphic user interface (GUI) element that one sees on a screen is and does. For example, such a button guide would explain that if…
Read More
A Guide to Technical Writing Certification and Top Certificate Programs
What is a Technical Writing Certification? A technical writing certification is an industry-recognized credential that signals to employers that the holder has the skills and knowledge to produce documents in a specific field. Benefits of a Technical Writing Certification There are many benefits to obtaining a technical writing certification. The most obvious benefit is that…
Read More2 Job Moves for Writers in a Tight Market
We’re in a tight market, although probably more so for copy writers than technical writers. It’s time to re-group, re-position, and update that resume. Here are two suggestions: If you have an energy or environmental background, it’s time to re-position yourself as a “Green Writer” which covers both the alternative energy sector and environmental protectionism.…
Read MoreTechnical Writing – What's the Difference Between Copy Writing and Technical Documentation?
© Ugur Akinci There are four different goals of writing, depending on the writer and the assignment in question. Writers try to 1) sell 2) teach 3) move, or 4) administer others. And these goals give rise to the following four types of writing: 1) Copy writing (sell) 2) Technical writing (teach) 3) Fiction/Creative writing…
Read MoreTechnical Writing Job That Pays $100K
Introduction It’s important from time to time just to remind ourselves of the kind of opportunities that still exist out there for technical writing and qualified technical writers even during economic downturns. Here is one such full-time writing position, offered by a U.S. Federal Agency to U.S. citizen writers. Pays Well It pays a salary…
Read MoreWhat is a Retronym?
Introduction Would you believe if I told you that you use one “retronym” after another whole day long? You probably wouldn’t because, as a life-time student of English, I also didn’t know for years what a “retronym” was. The reason I’m sharing this with you is my firm belief about the power of becoming fully…
Read MoreResearching a Technical Document
There are many preparatory steps in technical writing that you as a writer need to take before actually sitting down and start writing a technical document. 7 Issues to Consider Here are 7 issues you need to consider in the pre-production phase of your documentation project: Purpose will you be generating the technical document in…
Read More
Wealth of Indexing Options in OpenOffice and LibreOffice
Introduction Indexing is indispensable for almost all books and documents out there. A satisfactory user experience would not be complete without a well organized and written index. OpenOffice and LibreOffice, two free and open-source office productivity software suites, offer such a wealth of indexing options. Indexing Options in OpenOffice Select Insert > Indexes and Tables…
Read More
OpenOffice Writer Toolbars
Introduction Did you realize how many toolbars OpenOffice Writer offers? It is simple enough for a quick memo, yet powerful enough to create complete books with contents, diagrams, indexes, etc. You’re free to concentrate on your ideas while OpenOffice Writer makes them look great. Toolbars Galore It offers THREE separate toolbars for designing forms alone.…
Read More