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.
RE: best practices for internal repository of published docs?
Subject:RE: best practices for internal repository of published docs? From:"Gordon McLean" <Gordon -dot- McLean -at- GrahamTechnology -dot- com> To:"'Sam TechWriter'" <samtechwriter -at- yahoo -dot- com>, "'Pro TechWriter'" <pro -dot- techwriter -at- gmail -dot- com> Date:Thu, 12 Jul 2007 10:43:33 +0100
You say you have an intranet available. Then you say you don't want to
change "the way we do things around here". Which begs the question, what IS
the way things are done around there? Is the intranet used heavily? Would
people actually expect the docs to be there and are a little puzzled as to
why they need to head off onto a network drive to get them??
Not sure why you mention "fewer changes". Our intranet (Publications
specific area) has static pages which list the documents available for a
particular release. We also, recently, added a new 'draft' page which lists
useful information which isn't in the formal doc set (yet) but may be useful
to our staff. And with a small amount of planning you can double up... I
know that some of our staff know the machine and directory where our
intranet pages live. They are welcome to browse the network (using our
semantically named folders) to find what they want that way. Maybe you could
start with a network area and build the intranet on top??
As ever, the main crux is "know your users". The search for best practices
stops as soon as you leave your company boundaries. What is right for me may
not be right for others.
HTH
Gordon
-----Original Message-----
From: techwr-l-bounces+gordon -dot- mclean=grahamtechnology -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+gordon -dot- mclean=grahamtechnology -dot- com -at- lists -dot- techwr-l -dot- c
om] On Behalf Of Sam TechWriter
Sent: 11 July 2007 19:03
To: Pro TechWriter
Cc: techwr-l
Subject: Re: best practices for internal repository of published docs?
Pro TechWriter asked:
"Do you have an intranet available to you? We have published our docs in a
"library" format in WebHelp format to the company intranet. You could also
use Sharepoint or even a department Web site built with FrontPage or
Dreamweaver. This would allow you to add a search capability and an index."
Although we have an intranet available, I'd like to explore alternatives
that require fewer changes to "the way we do things around here." I have a
feeling that a publishing process (and resulting repository) with fewer
changes has greater chance of buy-in from others here in my company. I guess
what I'm really asking for is ideas for organizing directories on a file
share so everyone can find what they want independent of related CD build,
product, or audience. Although some of these details will have to be
specific to my company, I'm sure other technical writers may have
suggestions based on similar experiences in their companies.
PT, I do appreciate your reply and I may "resort" to this probably-better
option anyway, but right now I'm interested in understanding a variety of
approaches tried by those on this list.
Thanks,
"Sam TechWriter"
(Seattle, WA, USA)
____________________________________________________________________________________________________
This email (and any attachments) is private and confidential, and is intended solely for the
addressee. If you have received this communication in error please remove it and inform us via
telephone or email. Although we take all possible steps to ensure mail and attachments
are free from malicious content, malware and viruses, we cannot accept any responsibility
whatsoever for any changes to content outwith our administrative bounds. The views represented
within this mail are solely the view of the author and do not reflect the views of the organisation
as a whole.
____________________________________________________________________________________________________
Graham Technology plc
Registered in Scotland company no. SC143434
Registered Office India of Inchinnan, Renfrewshire, Scotland PA4 9LH
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-