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.

258 lines
11 KiB
Markdown

11 months ago
# Hello worlding
11 months ago
11 months ago
In this presentation i will look at the work made across the 2 years & __how it changed my understanding of programming and code documentation.__
11 months ago
11 months ago
__Code documentation as a broad set of practices__: comments in code, readme files, tutorials, guides, references, moments of collective learning, workshops, pair programming and collaborative versioning.
11 months ago
11 months ago
These aspects are __usually marginal in software development__: byproducts surrounding the real thing, extra work, and demand of resources often not available in the scarce economy around documentation.
11 months ago
11 months ago
I would like to focus on these marginal zones, bring them to the center and reflect on how they can enrich practices of programming, __opening entry points and backdoors into the making of software for people that are usually left out__.
11 months ago
The institutional required list of things done during these two years is left in the background, squint your eyes and move the cursor to the edges to see through.
11 months ago
11 months ago
## Getting startled
11 months ago
11 months ago
- Some previous experience in programming
- mainly used to develop interactive tools
- for visual art, performance and dance
- for corporate web design / development
11 months ago
<br>
11 months ago
- Code to understand our surroundings
- Code as craftmanship
- Code as service
- Code as solution
- Code as profession
- Code as product
11 months ago
<br>
11 months ago
- Enroll in XPUB, meet the group
- Different backgrounds ~ skills ~ values
- Different ways of working together
- __how to program together with different programming knowledges?__
11 months ago
11 months ago
<br>
__started documenting things__
![documentation workout](https://hub.xpub.nl/soupboat/~kamo/static/img/workout.png)
_intro on my page in the soupboat_
11 months ago
11 months ago
<br>
11 months ago
11 months ago
- First months: incredible
- New things: self-hosting, soupboat as shared space, terminal, python
- Terror of modifying files in the soupboat and break everything
- Timid and minimal edits in homepage
- Made a lot of different prototypes
- It's cute to look back and see from where we started
11 months ago
11 months ago
<br>
11 months ago
11 months ago
![screen of soup-gen](https://hub.xpub.nl/soupboat/~kamo/static/img/recap/soup-gen-2.jpg)
_soup generator aka our first prototype_
![screen of soup-gen with tech questions](https://hub.xpub.nl/soupboat/~kamo/static/img/soup.png)
_doubts for the soup gen_
<br>
11 months ago
- __but also traumatic!__
- Severe stress after first two SIs
- Friction and contrast between
- Care within the group, attention to group dynamics
- Group expectations and ambitions for projects
- Deadlines and production plans
11 months ago
11 months ago
<br>
11 months ago
11 months ago
- __Ended up centralizing a lot of technical work 😞__
- Always available and excited to share / offer skills to make things happen
- But not always taking into consideration the overall group engagement with programming
11 months ago
11 months ago
<br>
11 months ago
11 months ago
__realized after many year of collective practice that there's a difference in making something for a group and making something together.__
11 months ago
11 months ago
Started appreciating other kind of values in code
11 months ago
<br>
- the parable of SI18 was healing
11 months ago
- smaller groups, rotation between caretakers and contributors, weekly releases
- sometimes difficult give value to things made in such a rush
- but on the course of the issue something changed
11 months ago
- at the beginning we were just giving themes or keywords as prompts
11 months ago
- later on it transformed to __offering formats and inviting particular workflows__
11 months ago
## From code to code documentation
11 months ago
- These ideas of __invitation, offering, proposal__ resonated a lot
- especially with the concept of __situated software__
- aka software made with and within a group
- __shared infra- and social- structure__
<br>
- code as invitation
- code as offering
- code as proposal
- code as care
11 months ago
<br>
11 months ago
- __when is code offered to others?__
11 months ago
- at first wondered if the moment of offering and proposal could have been the format of the __demo__
- _mother of all demos_ vibe
- but as an approach felt too frontal and binary
- developer vs user
- and i didn't feel really connected with _demoscene_
11 months ago
Eventually focused on something closer to home: __the friction between being frustrated having to deal with undocumented piece of software, and at the same time never documenting anything.__
11 months ago
11 months ago
And realized that what I'm interested on besides developing tools, is the moment of development itself. And a way to share that with others it's code documentation. Creating entry points and opening backdoors to the making of software.
11 months ago
11 months ago
> __Code documentation is an interface between the code, the user, the developer, and the world.__ Living close to the source code, but at the same time being less rigid and more expressive, it seems to be an ideal surface to influence software development practices.
11 months ago
11 months ago
That was more or less the moment when I started being more aware about my and others approach to documentation. And learned how diverse and rich practices of code documentation can be:
11 months ago
11 months ago
- Putting more efforts in writing readmes
11 months ago
- Hosting workshops to share code
11 months ago
- Organizing documentation sessions to dedicate time to writing docs
11 months ago
- Making zine with prompts to start documenting: [care for code](https://hub.xpub.nl/soupboat/~kamo/care_for_code/)
11 months ago
![scanned materials for the documentation sessions. some sticker, flyers and text, printed on pink paper](https://hub.xpub.nl/soupboat/~kamo/projects/dyc/gadget.jpg)
_Materials printed for documentation session_
![Scan of the zine Care for Code](https://hub.xpub.nl/soupboat/~kamo/static/img/care_for_code.png)
_Care for code - zine for Documentation Session_
11 months ago
__Code documentation as personal understanding__
![a drawing with a cute bird playing the role of an API between server and client](https://hub.xpub.nl/soupboat/wlist/img/chae_api.jpg)
![a screenshot of a meme with a soaked sweated man trying not to use the analogy of the restaurant to explain the api](https://hub.xpub.nl/soupboat/~kamo/static/img/miri.jpg)
![fancy graphic designed documentation to digest flask](https://hub.xpub.nl/soupboat/wlist/img/supi_flask.jpg)
_Chae's drawing - Miri's meme - Supi's diyry_
<br>
__Code documentation as shared struggle__
11 months ago
![comment in code: ](https://hub.xpub.nl/soupboat/~kamo/static/img/comment_1.png)
![comment in code](https://hub.xpub.nl/soupboat/~kamo/static/img/comment_2.png)
![comment in code](https://hub.xpub.nl/soupboat/~kamo/static/img/comment_3.png)
![comment in code](https://hub.xpub.nl/soupboat/~kamo/static/img/comment_4.png)
![comment in code](https://hub.xpub.nl/soupboat/~kamo/static/img/comment_5.png)
11 months ago
11 months ago
_Comments in the code screaming for help_
11 months ago
11 months ago
<br>
11 months ago
__Code documentation as collective practice__
11 months ago
11 months ago
![Documentation for a repeat function with some nice parrot](https://hub.xpub.nl/soupboat/~kamo/thesis/img/SI16_NB.jpg)
11 months ago
_Folder with Jupiter notebook files, each with a different piece of documentation for SI16_
![piece of flask documentation written with Chae](https://hub.xpub.nl/soupboat/~kamo/static/img/flask.png)
_Writing some documentation for Flask together with Chae_
11 months ago
- __Code documentation as poetic and political writing__
- Queer Motto API, The Screenless Office
- __Code documentation as invitation for others to participate__
- SI18 CMS for printing post-it
- __Code documentation as starting point for further explorations__
- See Kiwiboat, that lead to Diffractive Reader, that lead to Pad-bis
- __Code documentation as a way to question code__
- See the discomfort in writing-list, 4x-faster, pad-bis
11 months ago
11 months ago
The project is a restitution of this year long process.
11 months ago
## plans for final publication and grad show
11 months ago
__Code documentation is a marginal practice, often invisible labor, usually left in the background.__ For grad show and final pubblication would like to bring it more to the center.
11 months ago
There will be 2 kind of things at the exhibition
### 1. helloworlding.com
11 months ago
Is a small website to archive pathways through code documentation practice.
11 months ago
at the current stage a pathway is an annotated collection of readmes. Readmes are presented with a short intro and link directly at the place where they originally can be found, that is in their repos.
It will be exhibited on a small screen connected to the Soupboat, for the occasion going on a field trip at the slash gallery.
11 months ago
<style>
.double {
display: inline-flex;
flex-direction: column;
vertical-align: middle;
line-height: 1;
text-align: center;
}
</style>
11 months ago
This archive is a <span class="double"><span>reading</span><span>writing</span></span> machine.
- __reading__ because it's a curated restitution of different practices of code docs
- __writing__ because it systematizes a research process, offering a surface where to keep track of methods through time, and see through snapshots how they transform over time
11 months ago
<!-- Pathways available at the moment: -->
11 months ago
11 months ago
<!-- 1. welcoming language as a mode of address -->
<!-- 2. cover arts and visual entry points -->
11 months ago
11 months ago
_For the exhibition the website will work as an invitation, with the possibility to sign in to receive update about new pathways._
_⚠ work in progress_
11 months ago
### 2. readme readers
Keyword are:
__readme republishing__
__readme readers__
There will be printed snapshots of readme files mainly coming from tools developed in the context of the soupboat, bound together as _readme readers_ by means of a custom, loose binding setup.
These readers will be a snapshot of the current pathways curated in [helloworlding.com](helloworlding.com)
11 months ago
11 months ago
These are aspects of code documentation practices I want to be reflected in the installation setup:
- __proximity to the code__: as a lens to look at it, as an entry point to let people in. as a bait to lure a tech audience not so used to this kind of discourses about sociality around software.
- __multiplicity__: many different situations, many different ways to document, not 1 size fits all
- __worlding__: documentation can influence the way we think about code. can create worlds around it. system of values different from ultra optimization, productivity and tech solutionism
11 months ago
To bring under spotlight a theme that is __a niche in a niche__ requires to create some relatable entry points. Code documentation is a surface in the middle of different kinds of audience, so different kind of entry points are necessary.
![soupboat with legs](https://hub.xpub.nl/soupboat/~kamo/thesis/img/soupboat.jpg)
That's why for the exhibition im binding the readme readers with __clumsy 3d printed legs__. These legs started as a playful device to make our server run 4x faster, and eventually became one of visible marks of software developed around Soupboat.
11 months ago
As binding device they work as:
- a small pack of goofy creatures in the ecosystem of soupboat
- a playful display for a usually intimidating material
- embracing clumsyness, unfinished and provisional states, tryout and failures, commitment to constant gardening and care for code documentation, its readers and all the surroundings
11 months ago
![prototype legs binding](https://hub.xpub.nl/soupboat/~kamo/static/img/binding-legs.jpg)
11 months ago
11 months ago
![Prototype legs binding](https://hub.xpub.nl/soupboat/~kamo/static/img/logs.jpg)
11 months ago
11 months ago
### Future
11 months ago
11 months ago
[helloworlding.com]() will work as a hub to continue the research and practice around code docs, like the archive in the soupboat has done these two years.