Difference between revisions of "Documentation: Recommendations"
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | The documentation of the whole experiment | + | The documentation of the whole experiment is a '''shared''' responsibility between the CF and the user. Make sure you define before the start of the experiment [[Responsibility: Recommendations|'''who will document which steps''']] (CF staff or user) to ensure the documentation is complete. |
Provide [[:File:Documentation guideline.docx|'''guidance''']] how to document the procedure optimally. | Provide [[:File:Documentation guideline.docx|'''guidance''']] how to document the procedure optimally. | ||
| Line 5: | Line 5: | ||
If possible, [[Quality checkpoints: Recommendations|'''check''']] that the documentation is complete. | If possible, [[Quality checkpoints: Recommendations|'''check''']] that the documentation is complete. | ||
| − | Documentation can be done | + | Documentation can be done using a [[:File:Documentation guideline.docx|paper notebook]], an [[Management: Recommendations#ELN|electronic lab book]] (ELN) or a combination of both. |
| − | Documentation can be improved by using an [[ | + | Documentation can be improved by using an [[Management: Recommendations#ELN|'''electronic lab book''']] (ELN). ELNs have multiple advantages over traditional documentation. ELNs ensure documentation is complete, precise, relevant and easy to read. The data is structured, files and images can be uploaded to each entry (no glue…), links and handwritten notes can be added, and cross referencing is easy. Information is organised, easily searched, tagged and retrieved. Entries can be edited and corrected, with an automatic edit and version history of any changes made for integrity. ELNs are flexible, expandable, can be shared, backed up and take less space to store. |
| + | |||
| + | |||
| + | [[Start_here|Go back to menu]] | ||
Latest revision as of 13:01, 24 March 2021
The documentation of the whole experiment is a shared responsibility between the CF and the user. Make sure you define before the start of the experiment who will document which steps (CF staff or user) to ensure the documentation is complete.
Provide guidance how to document the procedure optimally.
If possible, check that the documentation is complete.
Documentation can be done using a paper notebook, an electronic lab book (ELN) or a combination of both.
Documentation can be improved by using an electronic lab book (ELN). ELNs have multiple advantages over traditional documentation. ELNs ensure documentation is complete, precise, relevant and easy to read. The data is structured, files and images can be uploaded to each entry (no glue…), links and handwritten notes can be added, and cross referencing is easy. Information is organised, easily searched, tagged and retrieved. Entries can be edited and corrected, with an automatic edit and version history of any changes made for integrity. ELNs are flexible, expandable, can be shared, backed up and take less space to store.
