I am currently revising some user-facing documentation for a new client. The existing documents were prepared by a member of staff, no longer working for the company concerned, who had never had any training in technical writing skills. There’s a series of about a dozen Word documents of about 20 pages each. All the formatting has been done without the use of styles, additional white space has been added with empty paragraphs, and all the graphics are floating. Even the Table of Contents has been created manually. These are all examples of inefficient ways to use Microsoft Word, and they are typical of work produced by people who are, in terms of their documentation skills, well-meaning amateurs. (They may well excel in their own professional fields, and they are probably really nice people too!)
I can deal with all these things, and if I am asked to, I can show people how to save time and energy by doing things in different ways that allow for consistency and repeatability across document sets.
The thing that has really upset me with these particular documents is the poor quality of the writing itself. The most grating offence against accepted current usage that this writer is guilty of is the use of an apostrophe to indicate the plural of nouns. I’ve seen “operator’s”, “user’s”, “extra’s”, and “area’s” – not one of them indicating a possessive – in just a few pages. Poor Lynne Truss would be having a fit by now, and to tell you the truth, I am nearly there myself.
Top 10 TechComm Influencers 2011
Most Influential Tech Comm Bloggers 2010
Pages
Blogroll
- 2moroDocs
- A Techie Tech Writer
- Communication Cloud
- Conradiator
- CyberText Newsletter
- DITA XML org
- ffeathers
- Firehead Blog
- Gryphon Mountain
- I Heart Tech Docs
- I'd rather be writing
- Just Write Click
- Less Work, More Flow
- Mardahl.dk
- Michael Priestley
- One man writes
- Palimpsest
- RJ Jacquez
- RoboColum(n)
- Talks like a scientist
- techcommdood
- The Agile Technical Writer
- The Content Wrangler
- UAX (User Assistance)
Archives
- January 2012
- December 2011
- November 2011
- October 2011
- September 2011
- August 2011
- May 2011
- March 2011
- February 2011
- January 2011
- December 2010
- November 2010
- September 2010
- August 2010
- July 2010
- June 2010
- May 2010
- April 2010
- March 2010
- February 2010
- January 2010
- December 2009
- November 2009
- September 2009
- August 2009
- July 2009
- June 2009
- May 2009
- April 2009
- March 2009
- February 2009
- January 2009
- December 2008
- November 2008
- October 2008
- September 2008
- August 2008
- July 2008
- June 2008
- May 2008
- April 2008
- March 2008
- February 2008
- January 2008
- December 2007
- November 2007
- October 2007
- September 2007
- August 2007
- July 2007
- June 2007
- May 2007
- April 2007
- March 2007
- July 2006
- October 2005
- September 2005
- August 2005

p>






Ah yes; being a technical writer (or anyone who cares about good writing) gives one so many more stressors to deal with!