Tag Archives: Technical Editor

Books Reading Technical Writing

Book Review: Microsoft Manual of Style, 4th Edition; Microsoft Corporation

Microsoft Manual of Style, 4th EditionAs a technical writer, the Microsoft Manual of Style is the first style guide I reach for when I am a working on documentation project when the organization doesn’t have a corporate style guide. Now, Microsoft has published the Microsoft Manual of Style, 4th Edition that includes some timely updates documenting how Microsoft’s editorial style is adapting and changing to meet new technologies.

The Microsoft Manual of Style is a soup to nuts guide to the Microsoft style for writing technical documentation. I like its holistic approach that includes principles of Microsoft Style, web content, international audience considerations, writing about user interface guidelines, and writing procedures.  It rounds out with a well-documented usage dictionary. The Microsoft writers and editors behind this edition have put together a solid style guide that can serve both experienced and novice writers alike even just to help resolve stylistic arguments during the writing and editing of documents. Some notable updates in this edition include how Microsoft handles writing about mobile phones, gestures, Search Engine Optimization (SEO), and for international audiences.

read more »

 
Courseware Development Productivity Project Communications Technical Writing

Updating and Revising Technical Documents: A Primer

While maintaining technical documents can be the most boring part of the technical writer’s job in some organizations, it’s a necessary part of the business especially in the federal government and other policies and procedure driven environments.

However, updating documents often falls down the list of priorities and becomes a reactionary task versus a natural element of business operations. This leads to such a simple task being flubbed and lapping up more resources and operational budget than first thought.

I am seeing more smaller contracts now for writers to come in an update technical documents especially policies and procedures guides and got to thinking how I like to update documents:

read more »

 
Technical Writing Uncategorized Work

Lessons Learned From My Former Life As A Computer Book Technical Reviewer

I was a computer book technical reviewer earlier in my career. It was a freelance gig, but I still consider the work one of the more formative chapters in my professional writing career even though it wasn’t actually writing work.

Computer book technical reviewers sometimes called technical editors are responsible for ensuring the technical accuracy of computer book manuscripts. The work taught me to pay attention to technical details, which in turn went onto influence my work as a technical writer and freelance writer.

The lessons I learned include:

read more »

 

© 2012-2013 Will Kelly All Rights Reserved -- Copyright notice by Blog Copyright