Re: Suggestions for setting standards for documentation

[Sean Wheller <seanwhe -at- yahoo -dot- com>]

--- envvy harris <envvy -at- yahoo -dot- com> wrote:
> 1. Set the standard for correct document structure
> with ALL required work objects and checklists.

There are no rules, only guidelines. Some ideas are
embodied in the standards relating to Technical
Communications. Look at the ISTC to get the overall
picture (http://www.istc.org.uk/site/standard.asp).

Much of the British Standards recommendations are soon
to be legacy, replaced by ISO/IEC 18019
(http://www.iso.org). The latest draft looks good and
is much more in context of electronic technology.
Definitely look at ISO/IEC 18019 in context of User
centered design standards and in particular with
ISO/IEC 15910. This should
help.(http://www.usability.serco.com/trump/resources/standards.htm).

> 2.  Establish firm guidelines for where all
> documents are stored.

Document storage is more than just storage and backup
etc. It's also about Content and Knowledge Management.
I suggest reading the materials on these sites:

http://www.opentext.com/
http://www.documentum.com/
http://www.hummingbird.com

You may also look at Apache Cocoon and the Lenya
project (http://cocoon.apache.org). Also keep an eye
on MS SharePortal and the MS SQL Server.

> 3.  Establish a process/team to regularly evaluate
> compliance with standards and guidelines.

If your company has a TQM or a person in charge of QA
or ISO let them handle it. One tip: make sure your
processes are integrated to all departments, R&D,
Engineering, Testing, Marketing etc.

Enjoy,

Sean Wheller


__________________________________
Do you Yahoo!?
Yahoo! SiteBuilder - Free, easy-to-use web site design software
http://sitebuilder.yahoo.com