Information Technology Reference
In-Depth Information
Table 3. OMII LOR quality evaluation criteria
Criteria
Sub-criteria
Description/Ideal
A high overall score here indicates that the user can be reasonably confident that the supporting documentation
will answer the majority of the queries. How comprehensive and useful is the provided documentation? Ideal:
a high score indicates that the documentation provides sufficient depth and coverage to be useful for those try-
ing to utilize the product
for its main purpose/function
Concise summary of the software. Ideal: Information as to what the software does
and how one can quickly get started with it
Introductory docs.
Information relating to the environment required for running this software. Ideal: is
the environment required for this software well described?
Pre-requisite docs.
Information on how to install the software. Ideal: clear instructions on installation
procedures of the software
Installation docs.
Information on the API. Ideal: clear simple user manual with usage scenarios and the
sample code
User docs.
Documentation
Information on how to administer the software. Ideal: clear instructions on how to
configure the software and maintain it in operation
Admin docs.
Details how to use the software. Ideal: clear, simple step-by-step description on how
to use the software with code samples, if appropriate
Tutorials
Functional
specification
Functional specification of the software. Ideal: clear, simple description of product's
functionality
Implementation speci-
fication
Implementation details of functional specification. Ideal: this document should con-
tain not only the implementation details but also justifications for any choices
Details of product testing. Ideal: details of the test plans, test code and results from
running on various platforms and scenarios. Also describe how the user can repeat
the same tests
Test documents
The evaluator will use the provided documentation to try and use the software. Their success (or failure) in us-
ing the software will demonstrate whether the contributed software provides useful functionality. Examination
of the technical components of the software. Ideal: can the product be deployed and does it run successfully
using the provided docum
entation?
Software and environment changes necessary to support the installation of the
software. Ideal: are the pre-requisites accurately described and in sufficient depth to
install and run the software?
Pre-requisites
Deployment of the product into a server or client environment. Ideal: how easy is the
deployment of this software into the required environment?
Deployment
Technical
Evaluating the correct operation of the product. Ideal: is it clear how one can verify
that the software has been successfully deployed and is operating correctly, e.g. post-
installation tests?
Verification
Determination as to the stability of the production. Ideal: does the software run reli-
ably under reasonable usage and are there any tests to support this?
Stability
Assessment of the scalability of the software. Ideal: how well does the software
respond to high levels of utilization and concurrent client activity and are there any
tests to support this?
Scalability
Coding
Inspection of the code within the software
continues on following page
Search WWH ::
Custom Search