Discussion Locked

Documentation Acceptance Criteria

0 helpful
1 reply
Closed to new repliesThis discussion is closed. It stays readable, but it takes no new replies.

I am looking for a clear set of Acceptance Criteria for project and system documentation to include in our 'standard'. With criteria I mean an objective 'measurement' that the delivered documentation complies to the expected quality.

For specific project management documentation I can use a standard Table of Contents.

I have more problems with User documentation and Manuals. What makes a good manual? How can I prevent that a manual is useless for easy use but the vendor argues that everything is included (for instance, just summed up).

Same goes for technical installation docs, development documentation (how can I ensure that somebody from outside the vendor can also read this, if we want to have additional development done by somebody else - internal or external), etc.

Thanks in advance

Steph

1 reply

by crzonu

For User documentation it's fairly common to specify usability acceptance criteria (i.e. "A novice user with no prior experience can successfully complete selected tasks within XX minutes using the documentation.").

For Technical documents, you might want to specify that certain elements (i.e. Table of Contents, Index, Glossary, etc.) are present, complete, and consistent.

Having an overall set of requirements for style, format, and minimum contents for all of your documentation will probably go a long way in ensuring that you get a somewhat consistent "look and feel", which plays an important part in how your documentation is perceived and used. You can borrow liberally from existing style guides (Xerox, Apple, and Microsoft all have excellent guides you can use as a basis for your own.)

Having said all that, your best options are to focus on developing one set of documents that you can use as a standard for others and to foster relationships with the folks (internal and external) who develop your documents so they come to understand your needs and your style.

Hope this helps!

This discussion is closed to new replies.