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.
Subject:Document control procedures From:"Christopher.Shade" <Christopher -dot- Shade -at- PSCMAIL -dot- PS -dot- NET> Date:Mon, 5 Feb 1996 10:24:00 -0600
especially William,
some thoughts on directory structure... i recently worked in the QA
group at a client site. the project development approach, which I
found very odd, consisted of three groups: QA, Coding and Systems
Management. the QA group was responsible for everything but coding
and systems management, and included the writing of all docs except
for the design. these three groups practiced a very chaotic approach
to managing docs. i implemented a formal directory structure, topped
by a directory named PROJECTS, and bestowed access to all three
groups. it has been successful as a preliminary approach. in the
PROJECTS directory, i established the following directories:
SUBDIRECTORY CONTAINS
------------ --------
DESIGN Design Document
FUTURE Requirements for next release
GENERAL General files such as memos
GRAPHICS Graphics that are shared among the docs
GENERAL General files such as memos
ONLINE Files related to on-line help
OVERVIEW Any overview documentation
PROJPLAN Project Plan
REQMTS Requirements Document
STDS Standards specific to this project
TEST All test docs and subdirectories
TRAINING All training docs and subdirectories
USERMAN User Manual