Browse Source

adding the documentation session with kamo

pull/13/head
mb 2 years ago
parent
commit
3e3c52fa76
  1. 26
      content/2023/documentation-EN.md
  2. 25
      content/2023/documentation-NL.md
  3. BIN
      content/images/lifecycle.jpg

26
content/2023/documentation-EN.md

@ -0,0 +1,26 @@
---
Title: Let's write some code documentation!
Date: 2023-03-10 19:00
Category: gathering
Tags: code, documentation
slug: code-documentation
lang: en
event_start: 2023-03-23 19:00
event_duration: 2h
featured_image: /images/lifecycle.jpg
summary: Let's write some code documentation! For your new coding project, for the cryptic library you downloaded recently, for a script that you want to share with others! Enter the documentation sessions. Two hours where to sit with source code and write something about it.
status: draft
---
Let's write some code documentation! For your new coding project, for the cryptic library you downloaded recently, for a script that you want to share with others!
Too many pieces of code are left alone out there: without an entry point, forgotten, while outside is raining. Wouldn't it be nice to take care of them?
Enter the documentation sessions. Two hours where to sit with source code and write something about it. From simple instructions to in-depth explanations, or maybe some drawings to illustrate the overall process. You name it.
Writing documentation is difficult! But let's face this together: prompts and suggestions will be offered for inspiration, and coffee and snacks for restoration. If you want there will be space to share your work and exchange feedback, if not no prob: just enjoy the cozy music and write some docs.
Practical info: For people that thinkers with code, no matter the experience. Processing, P5.js, TouchDesigner, Javascript, Python, doesn't really matter! All code looks better when is documented! Come alone or with friends, bring your laptop and something to document.
* **Date**: Thursday 23rd of March
* **Time**: 19:00-21:00 CET
* **Location**: Varia (Gouwstraat 3, Rotterdam)

25
content/2023/documentation-NL.md

@ -0,0 +1,25 @@
---
Title: Let's write some code documentation!
Date: 2023-03-10 19:00
Category: gathering
Tags: code, documentation
slug: code-documentation
lang: nl
event_start: 2023-03-23 19:00
event_duration: 2h
featured_image: /images/lifecycle.jpg
summary: Laten we code documenteren! Voor je nieuwe codeerproject, voor de cryptische bibliotheek die je onlangs hebt gedownload, voor een script dat je met anderen wilt delen! Neem deel aan de documentatie sessies, waarin we twee uur de tijd nemen om (bron)code te lezen en er iets over te schrijven.
status: draft
---
Laten we code documenteren! Voor je nieuwe codeerproject, voor de cryptische bibliotheek die je onlangs hebt gedownload, voor een script dat je met anderen wilt delen! Te veel stukken code liggen er maar wat verloren bij: zonder introductie en half vergeten, terwijl het buiten maar blijft regenen. Zou het niet fijn zijn om ze een beetje aandacht te geven?
Neem deel aan de documentatie sessies, waarin we twee uur de tijd nemen om (bron)code te lezen en er iets over te schrijven. Van eenvoudige instructies tot diepgaande uitleg, of misschien wat tekeningen die het totale proces illustreren. Noem maar op, het kan vanalles zijn!
Documentatie schrijven is moeilijk! Laten we het samen doen: prompts en suggesties zullen op tafel gelegd worden ter inspiratie. Koffie, thee en snacks voor relaxatie. Als je dat wilt is er ruimte om je werk te delen en feedback uit te wisselen, zo niet geen probleem: luister naar de muziek en schrijf wat docs.
Praktische info: Deze sessie nodigt mensen uit die werken met code, ongeacht de ervaring. Processing, P5.js, TouchDesigner, Javascript, Python, het maakt niet uit wat je gebruikt! Alle code ziet er beter uit als het gedocumenteerd is! Kom alleen of met vrienden, breng je laptop mee en iets om te documenteren.
* **Datum**: donderdag 23 maart
* **Tijd**: 19:00-21:00 CET
* **Locatie**: Varia (Gouwstraat 3, Rotterdam)

BIN
content/images/lifecycle.jpg

Binary file not shown.

After

Width:  |  Height:  |  Size: 713 KiB

Loading…
Cancel
Save