[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
RE: Documentation Metrics
From: David C. Merrill, Ph.D. [mailto:email@example.com]
> 1. Audience Type
> - application user
> - programmer
> - system administrator
One document may apply to some or all.
> 2. Audience Technical Sophistication
> - novice
> - beginner
> - intermediate
> - advanced
Some documents may apply to a range of technical audiences.
> 3. Accuracy
> - awful
> - poor
> - fair
> - good
> - excellent
The awful and poor sound a bit too mean-spirited. I'd prefer a numeric
rating from 0 to 10 or something. Actually, numeric ratings (or ranges of
them) would work well for most of the categories.
> 9. Currency
> - badly out of date
> - slightly out of date
> - up to date
There is one point to note here. Sometimes a document becomes entirely
obsolete, not just out of date. Something like ipfwadm being replaced by
ipchains, or a program that is no longer maintained or needed.
Craig M. Buchek
To UNSUBSCRIBE, email to firstname.lastname@example.org
with a subject of "unsubscribe". Trouble? Contact email@example.com