Documentation: Recommendations - Revision history

Isabelle at 13:01, 24 March 2021

2021-03-24T13:01:55Z

Isabelle at 10:05, 16 March 2021

2021-03-16T10:05:26Z

Isabelle at 10:03, 16 March 2021

2021-03-16T10:03:17Z

Isabelle at 08:06, 16 March 2021

2021-03-16T08:06:06Z

Isabelle at 11:25, 19 January 2021

2021-01-19T11:25:14Z

Isabelle at 11:06, 19 January 2021

2021-01-19T11:06:58Z

Isabelle at 11:03, 19 January 2021

2021-01-19T11:03:07Z

Isabelle at 10:58, 19 January 2021

2021-01-19T10:58:13Z

Isabelle at 10:57, 19 January 2021

2021-01-19T10:57:30Z

Isabelle at 10:54, 15 January 2021

2021-01-15T10:54:17Z

← Older revision		Revision as of 13:01, 24 March 2021
Line 8:		Line 8:

	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.		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]]

← Older revision		Revision as of 10:05, 16 March 2021
Line 7:		Line 7:
	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 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 [[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!	+	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.

@@ Line 5: / Line 5: @@
 If possible, [[Quality checkpoints: Recommendations|'''check''']] that the documentation is complete.
-Documentation can be done in a [[:File:Documentation guideline.docx|paper notebook]], using an [[Management: Recommendations#ELN|electronic lab book]] (ELN) or a combination of both.
+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 [[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!

← Older revision		Revision as of 08:06, 16 March 2021
Line 1:		Line 1:
−	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 [[Responsibility: Recommendations\|'''who will document which steps''']] (CF staff or user) to ensure the documentation is complete.	+	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.

← Older revision		Revision as of 11:25, 19 January 2021
Line 7:		Line 7:
	Documentation can be done in a [[:File:Documentation guideline.docx\|paper notebook]], using an [[Management: Recommendations#ELN\|electronic lab book]] (ELN) or a combination of both.		Documentation can be done in a [[:File:Documentation guideline.docx\|paper notebook]], using an [[Management: Recommendations#ELN\|electronic lab book]] (ELN) or a combination of both.

−	Documentation can be improved by using an [[Management: Recommendations#ELN\|'''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 [[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!

@@ Line 5: / Line 5: @@
 If possible, [[Quality checkpoints: Recommendations|'''check''']] that the documentation is complete.
-Documentation can be done in a [[:File:Documentation guideline.docx|paper notebook]], using an electronic lab book (ELN) or a combination of both.
+Documentation can be done in a [[:File:Documentation guideline.docx|paper notebook]], using an [[Data management: Recommendations#ELN|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#ELN|'''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!

@@ Line 3: / Line 3: @@
 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 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!

← Older revision		Revision as of 10:54, 15 January 2021
Line 7:		Line 7:
	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!