documentation

1. Research Data Management documentation

2. Research Data ManagementLab Books • Why keep a Lab Book? • Records are important for development and writing up of your research. You should keep a lab book of your research. • a complete reconstruction of the experiment or measurement can be redone later • the work can be repeated for re-evaluation of the reported results • steps that led to the success or failure of a large project can be extracted • patent lawyers need properly documented evidence of inventions Getting Started with Research Data Management

3. Research Data ManagementLab Books • Paper lab books are at risk of lossor damage, and cannot be easily searched. • An electronic lab notebook (ELN) is a computer program designed to replace paper lab books; • easier to search upon, • simplify data copying and backups, • and support collaboration Getting Started with Research Data Management

4. Research Data ManagementLab Books • A good log should include: • Steps and procedures and precautions which are not obvious • References to other people's work, ideas, hints, and inputs • Parameters which might affect the outcome of the experiment • Equipment used, type numbers, serial numbers, any calibration steps taken • Sketches of experimental layout and traces on recorders, oscilloscopes, etc. • The date and time, names of other people observing • Rough error analyses taken during the experiment, repeat observations of doubtful readings, calibration errors allowed for Getting Started with Research Data Management

5. Research Data ManagementSoftware Documentation • A piece of code without adequate documentation cannot be efficiently or effectively developed, nor can it be understood by users in the future. • Documentation comes in many forms: • Requirements – statements that identify attributes, capabilities, characteristics, or qualities of a system • Architecture – an overview of the software, its purpose and its relations to an environment • Technical – the algorithms, interfaces, and APIs • End User – manual for end users, system administrators, and support staff • Marketing – how to market the product and analysis of the market demand Getting Started with Research Data Management

6. Research Data ManagementSoftware Documentation • In a research project lifecycle, these documentation forms are appropriate to different stages from the initial development, using the software for analysis, publishing the development and results of your research, and reuse by others later. • Requirements – statements that identify attributes, capabilities, characteristics, or qualities of a system : Using • Architecture – an overview of the software, its purpose and its relations to an environment : Using and Writing Up • Technical – the algorithms, interfaces, and APIs : Writing Up • End User – manual for end users, system administrators, and support staff : Using • Marketing – how to market the product and analysis of the market demand : Reuse Getting Started with Research Data Management