TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Madeline Bechtold mentioned in her message to Kendall Robinson that
his department should consider developing a style guide. That
sounds like good advice.
Years ago, when I was the company's only technical writer, I put
quite a bit of work into creating standards for all of our
documentation. I had standards for wording, spelling, layout,
etc. I concentrated on these major concepts: standardization/
consistency, ease of maintenance, and clarity.
It's not about two years since I was involved in documentation.
Many of the standards have been changed, etc. My old guides are
pretty much gone. It's probably no loss.
Are style guides being used by most of your organizations? What
sort of information is covered in your style guide? What parts
of the style guide do you believe have been the most effective at
improving the overall quality of your documentation?
In a somewhat related question, is there a formal sign-off process
in your organization for documenation? What functional areas are
involved in the sign-off (e.g., programmers, project leaders,
tech support, tech editors/writers, management)?
michael -dot- salsbury -at- cyberlink -dot- beaver -dot- pa -dot- us