Difference between revisions of "Documentation: Recommendations"

From Q-CoFa
Jump to: navigation, search
Line 3: Line 3:
 
Provide [[:File:Documentation guideline.docx|'''guidance''']] how to document the procedure optimally.
 
Provide [[:File:Documentation guideline.docx|'''guidance''']] how to document the procedure optimally.
  
If possible, '''check''' that the documentation is complete.
+
If possible, [[Quality checkpoints: Recommendations|'''check''']] that the documentation is complete.
  
 
Documentation can be done in a paper notebook, using an electronic lab book (ELN) or a combination of both.  
 
Documentation can be done in a paper notebook, using an electronic lab book (ELN) or a combination of both.  
  
 
Documentation can be improved by using an [[Data management: Recommendations|'''electronic lab book''']] (ELN), saving time and ensuring documentation is complete, precise, relevant and easy to read. 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. ELNs are flexible, expandable, can be shared, backed up and take less space to store!
 
Documentation can be improved by using an [[Data management: Recommendations|'''electronic lab book''']] (ELN), saving time and ensuring documentation is complete, precise, relevant and easy to read. 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. ELNs are flexible, expandable, can be shared, backed up and take less space to store!

Revision as of 10:57, 19 January 2021

The documentation of the whole experiment will be shared 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 in a paper notebook, using an electronic lab book (ELN) or a combination of both.

Documentation can be improved by using an electronic lab book (ELN), saving time and ensuring documentation is complete, precise, relevant and easy to read. 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. ELNs are flexible, expandable, can be shared, backed up and take less space to store!