Digitising History
CHAPTER 5 : DOCUMENTING A DATA CREATION PROJECT

 

Guide to Good Practice Navigation Bar


5.1 Why is good documentation important?

The maintenance of comprehensive documentation detailing the data creation process and the steps taken involves a significant but profitable investment of time and resources. It is more effective if documentation is generated during, rather than after, a data creation project. Such an approach will result in a better-quality data collection, as well as better-quality documentation, because the maintenance of proper documentation demands consistency and attention to detail. The process of documenting a data creation project can also have the benefit of helping to refine research questions and it can be a vital aid to communication in larger projects.

Good documentation is crucial to a data collection's long-term vitality; without it, the resource will not be suitable for future use and its provenance will be lost. Proper documentation contributes substantially to a data collection's scholarly value. The elements essential to good documentation are described in Section 5.2. At a minimum, documentation should provide information about a data collection's contents, provenance and structure, and the terms and conditions that apply to its use. It needs to be sufficiently detailed to allow the data creator to use the resource in the future, when the data creation process has started to fade from memory. It also needs to be comprehensive enough to enable others to explore the resource fully, and detailed enough to allow someone who has not been involved in the data creation process to understand the data collection and the process by which it was created.

 

© Sean Townsend, Cressida Chappell, Oscar Struijvé 1999

The right of Sean Townsend, Cressida Chappell and Oscar Struijvé to be identified as the Authors of this Work has been asserted by them in accordance with the Copyright, Designs and Patents Act 1988.

All material supplied via the Arts and Humanities Data Service is protected by copyright, and duplication or sale of all or any part of it is not permitted, except that material may be duplicated by you for your personal research use or educational purposes in electronic or print form. Permission for any other use must be obtained from the Arts and Humanities Data Service.

Electronic or print copies may not be offered, whether for sale or otherwise, to any third party.

Next Bibliography Back Glossary Contents