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.
documentation processes and management in your organizations?
Subject:documentation processes and management in your organizations? From:"peri jstar" <jstar99 -at- gmail -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Fri, 27 Oct 2006 16:18:34 -0500
Hello fellow tech writers, editors, collaborators, and web friends :)
Question for any and all of you. At my work I am trying to implement some
sort of loosely structured author/review/edit/approval process ("Loosely"
because I think my work is structured around their own milestones and is
probably very secondary to their own client-based projects which I generally
work around to accomodate).
Basically, I was hired as the sole technical writer for a company. They have
a wiki and Sharepoint sites with all sorts of documentation in every nook
and cranny (in every format too, .doc/.txt/.ppt/.html/etc.). There is no
level of lower management really above me and so in between editing other
miscellaneous docs, I basically go through their documentation sites and
reorganize and restructure the content for print and screen happiness.
However, I think it may fall to me to establish any sort of
creation/review/edit/approval process. My work also includes doc. design. so
I've already wrestled the basic style/numbering/images/etc. issues and
sometimes with this great forum's (meaning all of you of course) help ;) In
addition, the content I've put together in Word is supposed to make it's way
eventually into help files as well.
So currently I am wondering about how your organizations usually go about
it. The process I mean... Any info or websites or general
advice/descriptions from experience and etc. would be greatly welcomed. I am
attempting to try to pitch some ideas to my upper management about this, as
well as probably ask for a separate Sharepoint site, but I'd like to have
some good facts and thoughts put together so that I can be most
straightforward about my ideas. This is my first technical writing job and
so therefore I'm sure there are loads of situations/unintended consequences,
etc. that I have yet to think of!
Your input/feedback would be greatly appreciated :)
Thanks so much all!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList