Delete before use:
Template Version 1.0 (May 2017); Author: Tracy Scanlon ()
QA4ECV
Quality Assurance for Essential Climate Variables
Project Number607405
Deliverable:Deliverable Number – Product User Manual Document for Product Name
Responsible Partner: Name of responsible organisation
Delivery date: Date of issue
Add in the organisation symbols
Product User Manual for Product Name
(Version 1.0)
Authors
Author institutions / organisations
Change Record
Issue / Date / Pages Changed / CommentsIssue and draft number, i.e. 1A / Date changes approved / List of pages changed / Comments on why elements have been changed
CONTENTS
Executive Summary
1Introduction
1.1Product name
1.2Purpose and Scope of Document
1.3Definitions
2Available Products
2.1Intermediate Products
2.2Final and Sample Datasets
3Obtaining Product name
4Using Product Name
4.1Processing Product Data
4.2Processing Uncertainty Data
4.3Product Quality Information
5Validation Summary
6Case Studies
6.1Specific Use Case #1
7Contact Information
8References
TERMS & ACRONYMS
A full list of acronyms used within the documentExecutive Summary
Aim of the document.
Brief description of the product.
Summary of the contents of the document.
1Introduction
1.1Product name
A brief description of the product, including details of the parameter which the product relates to. The full product name and version number should also be included.
1.2Purpose and Scope of Document
Details of the aim of the document and how it is structured.
1.3Definitions
A list of definitions used within the document.
2Available Products
2.1Intermediate Products
A description of all the intermediate products generated by the processing algorithm, including the data format and where these can be obtained from. Provide details to the reader on how these might be obtained if they need them.
2.2Finaland Sample Datasets
A description of the final datasets available for the product. Provide details of how the sample datasets can be obtained (noting that information on obtaining the final datasets is provided in the following section).
Including details of the potential applications of these data products. Provide clear information on how they might be used and why they are useful.
3Obtaining Product name
A description of the steps required to obtain the data from the product producers. If there are differences between obtaining individual sub products, these should be presented in separate sections.
Details of further information / data which can only be obtained directly from the data producers should also be provided.
This section could include information on the file naming conventions utilised in the data product.
4Using Product Name
4.1Processing Product Data
A brief guide on how to start processing the data, describing briefly the type of application the product may be used in (referring back to Section 2 as required).
Include details of the tools available through the data producers and from other sources, if applicable.
In addition, include details of how the product should not be used, i.e. for what situations it is not applicable.
4.2Processing Uncertainty Data
This section should contain details of how to use the uncertainty information available with the product. Include details of the potential applications and benefits of using uncertainty data.
4.3Product Quality Information
Provide details on how the quality information relating to the product and any quality information might be used. Table 2 shows how this information could be displayed.
Table 1: Quality Flags in Product
Flag Name / Format of Flag / Derivation / Method for UseName in product. / Format of the data, i.e. independent binary layer. / Details of how the quality flag has been derived. / Details of how the user should utilise the data.
… / … / … / …
5Validation Summary
A summary of the validation of the product (taken from the validation report) – see separate guidance for validation report for further details.
6Case Studies
6.1Specific Use Case #1
Note: a copy of this section should be provided for each of the specific use cases available.
This section should provide details of a specific study which has used the product. This will include:
- Details of the aim of the use case.
- Details of the product version utilised.
- Details of the methodology utilised in the case study.
- Information on the successfulness of using the product for the intended application.
7Contact Information
This section should include contact information for the organisation (and person(s)) if applicable) who should be contacted for further information about the product.
8References
A list of all references and related documents.
- 1-