Product Documentation Survey

This report measures the quality and quantity of several different kinds of WorldForge product documentation.It was last updated on June 29th, 2002. The next update is scheduled for December 2002. If you want your product reviewed or updated before then, please contact ZephyrAlfredo.

Please note that this table compares the documentation of the products, not the products themselves. When it says silence-py's purpose is 'none', it means that its purpose is undocumented, not that it has no purpose.

CVS ModuleLocationPurposeDependsInstallationUsageLicenseHow to helpDesignCode
forge/clients/apogeeCVSthoroughadequategenericminimalGPLnonenonenone
forge/clients/dimeWebsiteexhaustivethoroughminimalnoneGPLminimalexhaustivethorough
forge/clients/equatorCVS@noneadequategenericnoneGPLnonenonenone
forge/clients/frostCVSadequatethoroughthoroughminimalGPLadequateminimalthorough
forge/clients/mistBoth@minimalnonenonenoneGPLnoneadequatethorough+
forge/clients/processCVSadequatenonegenericnoneGPLnoneminimaladequate
forge/clients/searWebsiteadequateminimaladequatethoroughGPLnoneminimalminimal
forge/clients/shardsCVS@nonenonegenericnoneGPLnonenoneminimal
forge/clients/silence-pyCVS-nonenonenonethoroughGPLthoroughnoneminimal
forge/clients/uclientBothadequatethoroughthoroughthoroughGPLadequateminimalminimal
forge/clients/vestriCVS-thoroughadequateadequateexhaustiveMISSINGadequatethoroughadequate+
forge/clients/yupCVS-thoroughthoroughadequatenoneGPLnoneminimaladequate
forge/libs/Atlas-C++CVSadequatethoroughadequatethoroughLGPLthorough*adequateadequate
forge/libs/Atlas-JavaCVSadequateadequateminimalnoneLGPLnonenonethorough
forge/libs/coalCVS-thoroughminimalnoneminimalGPLthoroughthoroughadequate
forge/libs/erisCVSthoroughthoroughthoroughthoroughGPLadequateminimaladequate
forge/libs/janusCVSthoroughnonenoneadequateMISSINGnoneminimalminimal
forge/libs/javaCVSadequatethoroughthoroughnoneGPLadequatenoneadequate
forge/libs/skstreamCVS-minimalnonethoroughminimalUNUSUALnoneminimaladequate
forge/libs/skstream2CVSminimalnonegenericnoneLGPLnonenoneminimal
forge/libs/varconfCVSthoroughthoroughthoroughthoroughLGPLnoneminimalnone
forge/libs/wfmathCVSadequateadequategenericadequateGPLadequatethoroughthorough
forge/protocols/atlasBoththoroughn/an/aadequateMISSINGnonethoroughn/a
forge/servers/cyphesisCVS-thoroughminimaladequatethoroughGPLnonethoroughminimal
forge/servers/cyphesis-C++BoththoroughminimalgenericthoroughGPLadequate*minimalnone
forge/servers/stageBoththoroughexhaustiveexhaustiveminimalGPLminimalthorough+adequate
forge/servers/venusCVS@minimalnonegenericminimalGPLnonenoneadequate
forge/tools/eideticCVSexhaustiveadequatethoroughthoroughGPLminimalthoroughthorough
forge/tools/PtahCVS-thoroughminimaladequatethoroughGPLnoneminimalminimal
forge/tools/zopeBothminimaln/an/athoroughGPLnonenonethorough
metaserverCVSadequateminimalminimalminimalGPLnoneminimalnone

Category Notes:

ChangeLog

June 2002

Removed Opal, Willow, and loupe due to inactivity.
Removed the 'Up to date' and 'Atlas Usage' categories. Up to date is too hard to track, and Atlas Usage is really part of code documentation.
Added several products that have seen CVS activity recently.
Added the 'Location' category.

March 2002