Add technical writing to the timetable

Also: Minor updates/fixes to the slides and demo.

Author: MakisH

04_documentation/technical_writing_demo.md

@@ -9,47 +9,51 @@ Example code is in [`04_documentation/examples/technical_writing`](https://githu
 
 - Add short description:
 
-    ```diff
-    + """2D diffusion equation solved with finite differences
-    + """
+    ```python
+    class SolveDiffusion2D:
+        """2D diffusion equation solved with finite differences.
+        """
     ```
 
 - Add long description, example usage:
 
-    ```diff
-    + See `main()` for example usage
+    ```python
+    """2D diffusion equation solved with finite differences
+    
+    See `main()` for example usage
+    """
     ```
 
 ## Method Documentation
 
 - Constructor:
 
-    ```diff
-    + """Constructs an uninitialized 2D diffusion solver
-    +
-    + After construction, initialize domain with `initialize_domain` and
-    + initialize the physical parameters with `initialize_physical_parameters`.
-    + """
+    ```python
+    """Constructs an uninitialized 2D diffusion solver
+
+    After construction, initialize domain with `initialize_domain` and
+    initialize the physical parameters with `initialize_physical_parameters`.
+    """
     ```
 
 - `initialize_domain`:
 
-    ```diff
-    + """Initializes domain and mesh of the domain
-    +
-    + - Sets width and height of the domain.
-    + - Also sets mesh width in x and in y direction.
-    + - Using these four values, the method computes the number of mesh elements in x and in y direction.
-    """
+    ```python
+    """Initializes domain and mesh of the domain
+
+    - Sets width and height of the domain.
+    - Also sets mesh width in x and in y direction.
+    - Using these four values, the method computes the number of mesh elements in x and in y direction.
+      """
     ```
 
 - `initialize_physical_parameters`:
 
-    ```diff
-    + """Initializes physical parameters and computes time step size
-    +
-    + You need to call `initialize_domain` before this method.
-    + """
+    ```python
+    """Initializes physical parameters and computes time step size
+    
+    You need to call `initialize_domain` before this method.
+    """
     ```
 
 - Ideally, we also add a link to source of time step size computation here.
@@ -58,15 +62,17 @@ Example code is in [`04_documentation/examples/technical_writing`](https://githu
 
 - Add to `initialize_domain`:
 
-    ```diff
-    + Parameters
-    + ----------
-    + w : float, default: 10.0
-    +     width of the domain
-    + h : float, default: 10.0
-    +     height of the domain
-    + dx : float, default: 0.1
-    +     mesh width in x direction
-    + dy : float, default: 0.1
-    +     mesh width in y direction
+    ```python
+    """
+    Parameters
+    ----------
+    w : float, default: 10.0
+        width of the domain
+    h : float, default: 10.0
+        height of the domain
+    dx : float, default: 0.1
+        mesh width in x direction
+    dy : float, default: 0.1
+        mesh width in y direction
+    """
     ```

04_documentation/technical_writing_slides.md

@@ -97,9 +97,9 @@ Bangerth and Heister, 2013: [What makes computational open source software libra
 
 - ... is a job profile between technical know-how (computer science, engineering, ...) and language.
 - ... can be a role in a software development team (*"documentation"*).
-- There is a whole community, e.g. [Write the Docs](https://www.writethedocs.org/).
 
-Much content of this lecture is taken from [Write the Docs](https://www.writethedocs.org/).
+Much content of this lecture is taken from [Write the Docs](https://www.writethedocs.org/),
+a community of technical writers.
 
 ---
 
@@ -170,7 +170,7 @@ From [py-RSE](https://third-bit.com/py-rse/documentation.html):
     - Good example: [deal.ii tutorials](https://dealii.org/developer/doxygen/deal.II/Tutorial.html)).
 - A **competent practitioner** knows enough to accomplish routine tasks with routine effort. -> Needs **reference guides, cookbooks, and Q&A sites**.
     - Good example: [preCICE config reference](https://precice.org/configuration-xml-reference.html)).
-- An **expert** need this material as well – nobody's memory is perfect.
+- An **expert** needs this material as well – nobody's memory is perfect.
 
 ---
 

timetable.md

@@ -82,3 +82,11 @@
 ## 8.2 – Wed, December 3, 2025
 
 - **90** min.: [Exercise: Packaging with CPack](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cpack_exercise.md)
+
+## 9.1 - Wed, December 10, 2025
+
+- **90** min.: Technical Writing: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/technical_writing_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/technical_writing_demo.md)
+
+## 9.2 - Wed, December 10, 2025
+
+- **90** min.: [Exercise: Reviewing with AI tools](https://github.com/Simulation-Software-Engineering/reviewing-exercise)