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.
> I would like to develop a documentation standards guide to address
> usage, style, naming conventions, templates and more; to be used by the
doc
> team, development, and possibly other teams. I would also like to develop
a
> formal documentation plan for the new product we are developing.
Are you going to tie the writers down to their desks and beat them with
sticks
as well?
:-) I'm just being silly. But I have a serious question to ask...
Do you really need all these things? What is hindering you right now from
writing documents such that you need all this stuff?
- - - - - - - - - - - -
Hi Andrew -
Nothing is hindering me from writing docs. The reason I see for implementing
a standard for all docs is that I have seen major discrepancies in usage,
style, layout, and naming conventions in our documentation. If everyone has
something in common to refer to, it would improve our docs. The
documentation plan might bring some awareness, for other teams, to what our
team delivers for a project, and might help with scope creep. At this very
moment, I actually have time to tend to these matters. So, I figure, why not
take advantage of the time, to make things a little tidier?
As for tying people to their desks and beating them, as of recently, I'm the
only writer. Hence, it would be mostly self-flagellation. ;)
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by DigiPub Solutions Corp, producers of PDF 2001
Conference East, June 4-5, Baltimore/Washington D.C. area. http://www.pdfconference.com or toll-free 877/278-2131.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.