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.
Speaking of writing guides, I'm a UX Architect tasked with developing style guidelines that developers will actually use and to do so for all aspects of the user experience - from the user interface guidelines for software engineers to a manual of writing style for content developers.
I laughed when I took this position. User experience practitioners write UI style guides and the like all the time, but I've seldom seen much published about how to make documentation usable. Of course, I'm hoping that technical writers will know about resources with which I'm not familiar.
At any rate, I've decided to draw on MMOS, 4th ed., and then supplement with our company style guidelines by employing the principles, practices, and patterns approach that is common to software engineering.
Does anyone know if anyone has done this for a writing style guide? If so, is there a published, publicly accessible example?
On an old home days note, I used to belong to the list years ago. What ever happened to Andrew Plato? :)
Kelley Walker
UX Architect
This electronic communication and any files transmitted with it, or attached to it, are confidential and are intended solely for the use of the individual or entity to whom it is addressed and may contain information that is confidential, legally privileged, protected by privacy laws, or otherwise restricted from disclosure to anyone else. If you are not the intended recipient or the person responsible for delivering the e-mail to the intended recipient, be advised that you have received this e-mail in error, and that any use, dissemination, forwarding, printing, or copying of this e-mail is strictly prohibited. If you received this e-mail in error, please return the e-mail to the sender, delete it from your computer and destroy any printed copy of it. Although our company attempts to sweep e-mail and attachments for viruses, it does not guarantee that either are virus-free and accepts no liability for any damage sustained as a result of viruses.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.
Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.
