meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
general:dokuwiki:how2document [2025/10/13 09:25] – ingogeneral:dokuwiki:how2document [2025/10/13 11:19] (current) – [References] ingo
Line 20: Line 20:
 Most practical modules in your curriculum require that you write a lab protocol at the end of your project. This lab protocol is your proof of achievement, and thus must be taken seriously, independent of whether it is graded or not. Please find below some information that should give you an idea of what to consider when writing a protocol. Most practical modules in your curriculum require that you write a lab protocol at the end of your project. This lab protocol is your proof of achievement, and thus must be taken seriously, independent of whether it is graded or not. Please find below some information that should give you an idea of what to consider when writing a protocol.
  
-<WRAP important><fs 1.5em>There is a difference between a lab protocol, and the daily documentation of your work in the WIKI. You can write, in principle, a lab protocol as a set of WIKI pages, but then we expect that it adheres to the guidelines listed below</fs></WRAP>+<WRAP important>There is a difference between a lab protocol, and the daily documentation of your work in the WIKI. You can write, in principle, a lab protocol as a set of WIKI pages, but then we expect that it adheres to the guidelines listed below</WRAP>
 ===== Objective ===== ===== Objective =====
 Before writing a lab protocol, you should ask yourself not only //why// your are writing a lab protocol, but much more //what you want to achieve// with the lab protocol. The answer is considerably simple: You write the lab protocol for  Before writing a lab protocol, you should ask yourself not only //why// your are writing a lab protocol, but much more //what you want to achieve// with the lab protocol. The answer is considerably simple: You write the lab protocol for 
Line 42: Line 42:
 Follow this [[https://www.thoughtco.com/how-to-write-a-lab-report-606052|LINK]] to get some additional ideas of how to write a good report Follow this [[https://www.thoughtco.com/how-to-write-a-lab-report-606052|LINK]] to get some additional ideas of how to write a good report
  
-<fs 1.5em><wrap tip>It is a good idea to carefully read the guidelines {{ :general:documentation:how_to_write_scientific_text.pdf |How to write scientific text}}</wrap></fs>+<wrap tip>It is a good idea to carefully read the guidelines {{ :general:documentation:how_to_write_scientific_text.pdf |How to write scientific text}}</wrap>
 ===== Some additional points to consider ===== ===== Some additional points to consider =====
  
Line 72: Line 72:
 ==== Tables ==== ==== Tables ====
 Like with figures, think about the information that should be provided with a table Like with figures, think about the information that should be provided with a table
-  * **tables have to be successively numbered** according to the order they are referred to in the text+  * **tables have to be successively numbered** according to the order they are referred to in the text. You must not mention Table 2 before Table 1.
   * **each table has to be mentioned in the text**   * **each table has to be mentioned in the text**
   * **each table has an informative title**. Table columns can be explained in the table footnotes   * **each table has an informative title**. Table columns can be explained in the table footnotes
Line 83: Line 83:
  
 ==== References ==== ==== References ====
-<wrap important></wrap>Remember why we use references? This is because we have to back up each statement in a scientific text with supporting evidences. These can be either previously published **and** peer-reviewed literature, or own data. In either case, the supporting information must be invariant with time. Thus, **Wikipedia cannot serve as a reference for scientific text** for several reasons. One of the most important ones is that article contents are subject to change over time!+<wrap important></wrap>Remember why we use references? This is because we have to back up each statement in a scientific text with supporting evidences. Supporting evidence is either your own data, or it stems from previously published **and** peer-reviewed literature with a stable digital object identified. In either case, the supporting information must be invariant with time. Thus, **Wikipedia cannot serve as a reference for scientific text** for several reasons. One of the most important ones is that article contents are subject to change over time! See the {{ :general:documentation:references-in-scientific-text.pdf |PDF}} provided by the Goethe University Frankfurt on this topic.
    * Make sure that references in the text, and your bibliography is correctly and consistently formatted. We prefer the //author, year// format for in-text citations over numbers.    * Make sure that references in the text, and your bibliography is correctly and consistently formatted. We prefer the //author, year// format for in-text citations over numbers.
 You can read more about how to cite in this document provided by the University of Cologne (in German only): [[http://uni-koeln.de/phil-fak/storyline2/story_content/external_files/Handout_%C3%9Cberpr%C3%BCfbarkeit.pdf|Handout_Ueberpruefbarkeit]]  You can read more about how to cite in this document provided by the University of Cologne (in German only): [[http://uni-koeln.de/phil-fak/storyline2/story_content/external_files/Handout_%C3%9Cberpr%C3%BCfbarkeit.pdf|Handout_Ueberpruefbarkeit]]