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 08:32] – [Structure of the protocol] ingogeneral:dokuwiki:how2document [2025/10/13 11:19] (current) – [References] ingo
Line 1: Line 1:
 +====== Scientific writing ======
 +Each scientific project culminates in writing scientific text. Reason is, that the data, information, and knowledge you gain by pursuing a scientific project only then becomes relevant if it is presented in a way that allows others to
 +  - comprehend what you did and why
 +  - understand what you found out
 +  - reproduce your work
 +  - embed it into state of the art in the research field
 +The only reasonable way to achieve this is, to cast the corresponding information into text, figures, and tables, just to mention the main three components of a text. 
 +Now, many people are not what one would call a __gifted writer__. Until recently, this resulted in text that leaves some room for improvement both with respect to content and style, and this after spending days and weeks on the text. Meanwhile, AI based solutions abound whose service can range from a mere polishing of your close to finished text to writing the entire text for you. <wrap important>Quite obviously, the latter is not acceptable irrespective of whether you write a protocol or a manuscript that is meant to be published in a scientific journal.</wrap>
 +Goethe University has compiled a [[https://lehre-virtuell.uni-frankfurt.de/knowhow/einsatz-von-generativer-ki-im-studium-handlungsempfehlungen-fuer-studierende/|catalogue of information]] about how you can make use of generative AI during your studies. Table {{ref>AI-use}} gives an idea about how to plan the use of generative AI tools((based on https://lehre-virtuell.uni-frankfurt.de/knowhow/einsatz-von-generativer-ki-im-studium-handlungsempfehlungen-fuer-studierende/; last accessed 2025-10-13)) . Please take a look at this information and stick to the rules that are specified therein. <wrap important></wrap>Discuss this topic also with your peers, tutors and professors.
 +<table AI-use>
 +^Phase in the writing process ^Support through AI ^Own contribution|
 +|Topic selection and literature research| Brainstorming Rough overview of topics | Focus on finding scientific sources|
 +|Reading and excerpting |Summary/outline for initial overview; Simplify text passages |Thorough reading and revising AI-generated texts|
 +|Rough draft |Formulating bullet points; Cooperative freewriting |Jot down key points; Write to clarify your thoughts; Revise AI-generated texts|
 +|Revise |Generate different text versions; Adjust style/perspective|Select and adapt the appropriate text version; Obtain human feedback|
 +|Linguistic correction|Specialized tools such as DeepL, Write, and Duden Mentor|Check if meaning has changed|
 +<caption><fs>Admissible use of generative AI during scientific writing</fs></caption> 
 +</table>
 ====== Lab protocols ====== ====== Lab protocols ======
 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 24: 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 41: Line 59:
  
 Each figure...  Each figure... 
-   * has a figure number. And figures have to be numbered in the order they are mentioned in the text +   * **has a figure number**. Figures have to be numbered in the order they are mentioned in the text. This rule applies also for the supplementary figures 
-   * has to be mentioned in the text +   * **has to be mentioned in the text** 
-   * has a short, informative title  +   * **has a short and informative title**  
-   * has a description that reflects the message of the figure. Make sure that the figure description does not end up in the main text +   * **has a description that reflects the message of the figure**. Make sure that the figure description does not end up in the main text 
-   * should be interpretable on its own. It is generally not optimal to refer to other figures (other than supplementary figures) in the figure caption +   * **should be interpretable on its own**. It is generally not optimal to refer to other figures (other than supplementary figures) in the figure caption. Likewise, you do not want to have figure descriptions in the main text. 
  
 <wrap important></wrap>Watch out for the following <wrap important></wrap>Watch out for the following
    * Screenshots as figures can be ok, but only when the image quality is sufficiently high.     * Screenshots as figures can be ok, but only when the image quality is sufficiently high. 
    * make sure that the font and the font size is uniform across the figures. Text must be <fs 0.1 em>sufficiently</fs> large to ease the access to the figure content.    * make sure that the font and the font size is uniform across the figures. Text must be <fs 0.1 em>sufficiently</fs> large to ease the access to the figure content.
-   * avoid figures landscape format +   * avoid figures in landscape format 
  
 ==== 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 
-  * avoid landscape tables +  * **avoid landscape tables** 
-  * avoid tables that extend over more than one page. Consider placing large tables into the supplement +  * **avoid tables that extend over more than one page**. Consider placing large tables into the supplement 
-  * don't use vertical lines to delimit table columns. Horizontal lines to delimit rows are ok, though+  * **don't use vertical lines to delimit table columns**. Horizontal lines to delimit rows are ok, though
  
 ==== Methods ==== ==== Methods ====
Line 65: 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]]