You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
133 lines
4.1 KiB
HTML
133 lines
4.1 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>Documentation Sessions</title>
|
|
<link rel="stylesheet" href="font/style.css" />
|
|
<link rel="stylesheet" href="style.css" />
|
|
</head>
|
|
<body>
|
|
<main>
|
|
<h1>2 hours of head space to write some <em>code documentation</em></h1>
|
|
|
|
<div class="session">
|
|
<div class="number">First session</div>
|
|
<div class="when">
|
|
March 15th <br />
|
|
16:00—18:00
|
|
</div>
|
|
<div class="where">
|
|
around XPUB Studio <br />
|
|
4th floor Wijnhaven
|
|
</div>
|
|
</div>
|
|
|
|
<div class="session">
|
|
<div class="number">Second Session</div>
|
|
<div class="when">
|
|
March 23rd <br />
|
|
19:00—21:00
|
|
</div>
|
|
<div class="where">
|
|
Varia <br />
|
|
Gouwstraat 3, Rotterdam
|
|
</div>
|
|
</div>
|
|
|
|
<p>
|
|
For your new coding project, for the cryptic library you downloaded recently, for a
|
|
script that you want to share with others!
|
|
</p>
|
|
<p>
|
|
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?
|
|
</p>
|
|
<p>
|
|
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.
|
|
</p>
|
|
<p>
|
|
Writing documentation can be tricky! 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.
|
|
</p>
|
|
|
|
<figure>
|
|
<img
|
|
src="img/trolley.png"
|
|
alt="would you rather develop tools for yourself or for other; but is the trolley problem"
|
|
/>
|
|
<figcaption>As the famous trolley problem goes: sharing is caring.</figcaption>
|
|
</figure>
|
|
|
|
<div class="example">
|
|
<a href="https://git.xpub.nl/kamo/pad-bis"
|
|
>Padliography - A bookmarking tool for pad (and link in general)</a
|
|
>
|
|
</div>
|
|
|
|
<div class="example">
|
|
<a href="https://git.xpub.nl/kamo/drw"
|
|
>DRW - A multi surface multi player real time drawing app</a
|
|
>
|
|
</div>
|
|
|
|
<div class="example">
|
|
<a href="https://git.xpub.nl/kamo/kiwiboat"
|
|
>Kiwiboat - How to connect and play around with the media wiki api</a
|
|
>
|
|
</div>
|
|
<figure>
|
|
<img
|
|
src="img/goat.png"
|
|
alt="the famous riddle of goat wolf and cabbage, but now is with coding"
|
|
/>
|
|
<figcaption>Code documentation = the boat in this puzzle</figcaption>
|
|
</figure>
|
|
|
|
<p>
|
|
These sessions are part of a research focused on code documentation intended not
|
|
just a technical list of procedures, but also a way to provide context and orientate
|
|
code in the world. A texture where to weave together multiple voices and diverse
|
|
registry, in order to re-enchant the making of software.
|
|
</p>
|
|
|
|
<p>
|
|
Documentation as a way to produce narrations around software. To create a world for
|
|
the code to inhabit, to stretch what is possible to do or to think with it.
|
|
</p>
|
|
<p>
|
|
Documentation as a space for the political in the software. A surface that could
|
|
host ideas in close contact with code, letting them entangle and shape each other.
|
|
</p>
|
|
|
|
<p>
|
|
<em> Read more:</em>
|
|
<a href="https://hub.xpub.nl/soupboat/wlist/situated_doc"
|
|
>Situated Documentation - a small brainstorming in the format of a list
|
|
</a>
|
|
</p>
|
|
|
|
<figure>
|
|
<img
|
|
src="img/discord_rant.png"
|
|
alt="person complaining in discord about software and documentation"
|
|
/>
|
|
</figure>
|
|
|
|
<p>
|
|
This project grows out of the contradiction of being frustrated in having to deal
|
|
with undocumented pieces of code, and at the same time never documenting anything.
|
|
</p>
|
|
<p>
|
|
Developed in the context of the Experimental Publishing master. A really nice place
|
|
to be.
|
|
</p>
|
|
</main>
|
|
</body>
|
|
</html>
|