|
|
|
|
@ -100,3 +100,37 @@ Two hours on ______, starting at ______!
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
## First session 15/03/2022
|
|
|
|
|
|
|
|
|
|
The first session took place at WdKA, 4th floor. Not super crowded, but still useful to prepare some contents and understand what could be useful.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Printed some materials:
|
|
|
|
|
|
|
|
|
|
__Stickers__
|
|
|
|
|
- Trolley meme
|
|
|
|
|
- Wolf, goat and lattuce meme
|
|
|
|
|
- Diataxis scheme
|
|
|
|
|
|
|
|
|
|
__Readings__
|
|
|
|
|
- [ReadMe Driven Development - Tom Preston Werner](https://tom.preston-werner.com/2010/08/23/readme-driven-development.html)
|
|
|
|
|
- [Suggestions for a good README](https://www.makeareadme.com/#suggestions-for-a-good-readme)
|
|
|
|
|
|
|
|
|
|
### Notes for next session
|
|
|
|
|
|
|
|
|
|
- Add more context! That could be: something from the thesis introduction
|
|
|
|
|
- where is this project coming from
|
|
|
|
|
- why are you doing it
|
|
|
|
|
- why do you think is important
|
|
|
|
|
- Could elaborate more where the documentation is in relation to the code
|
|
|
|
|
- where is the documentation?
|
|
|
|
|
- a (loose) connection between code and documentation
|
|
|
|
|
- not everyone use git for example
|
|
|
|
|
- Do not take for granted what a readme is! Introduce it!
|
|
|
|
|
- Some historical overview
|
|
|
|
|
- [Origin of "Readme" - Stack Exchange](https://softwareengineering.stackexchange.com/questions/96966/origin-of-readme/97132#97132)
|
|
|
|
|
- [The Jargon File](http://catb.org/%7Eesr/jargon/html/index.html)
|
|
|
|
|
- Offer it just as an option, mention other options
|
|
|
|
|
- Critical read of ReadMe Driven Dev
|
|
|
|
|
|
