Technical Writing – 4 Ideas to Organize Your Technical Document Images and Screen Shots
Introduction Most technical writers would include at least a few images to illustrate a point, or screenshots that accompany the description of a certain step-by-step procedure, etc. Organizing such images can really become a problem, especially when you have dozens and hundreds of them. Finding, editing, and importing them can quickly become a logistical nightmare,…
Read MoreTechnical Writing – Make $62,780 a Year as a Technical Communicator
© Ugur Akinci I did not make up the annual income figure in the headline. That is the Average Annual Wage earned by technical communicators across the United States in 2007 according to the “2007 Technical Communicator Salary Survey” conducted by Society for Technical Communication. For example, in California, technical writers made as low as…
Read MoreTechnical Writing – VAED Method to Document a GUI Element
In database applications, CRUD is an important principle to observe. It is an acronym that stands for: Create (C) [i.e., connect to] database Read (R) database Use (U) data Destroy (D) [i.e., disconnect from] database When documenting the features of a GUI (Graphic User Interface), there is a similar ACRONYM that can help you create…
Read More
Technical Writing – How to Use the Pending Marker in FrameMaker
Introduction FrameMaker (FM) is such a wonderful software to write long and complicated books and documents. In my 20-plus years of experience as a writer and information designer, nothing came close. FM has a very powerful built-in marker functionality with which you can mark not only your index words and cross-references, but your “pending stuff”…
Read More