diff --git a/projects/birthday-card/documentation.md b/projects/birthday-card/documentation.md new file mode 100644 index 0000000..b9bd7ba --- /dev/null +++ b/projects/birthday-card/documentation.md @@ -0,0 +1,12 @@ +--- +categories: + - Web +date: 30/10/2022 +description: draw your own b-day cards +git: https://git.xpub.nl/kamo/hbs +slug: birthday-card +title: Birthday Card +url: https://hub.xpub.nl/soupboat/hbs/ +--- + +Just a birthday card that you need to draw yourself, powered by panel.js and spaghetti.js diff --git a/projects/gpp/compass_reference.jpg b/projects/gpp/compass_reference.jpg new file mode 100644 index 0000000..3306717 Binary files /dev/null and b/projects/gpp/compass_reference.jpg differ diff --git a/projects/gpp/documentation.md b/projects/gpp/documentation.md index 11b5c0c..4faf594 100644 --- a/projects/gpp/documentation.md +++ b/projects/gpp/documentation.md @@ -13,79 +13,123 @@ title: Graduation Project Proposal ## Draft Project Proposal +_note: I'm using the words toolkit, handbook, map, collection of tools, practices or devices as interchangeable. Read it crossing your eyes, as a kind of not-fixed-superposition that will eventually stabilise during the research_ + ### What do you want to make? -Focus on software documentation as an interface between code, users, developers, communities, and the world. +- A toolkit to explore _software documentation_ as publishing surface. + +- An extensible set of tools and practices that focus on _software documentation_ as an interface between code, users, developers, communities, and the world. +- A handbook with a strong attention on the economy of different knowledges present in _software documentation_. + +- A collection of small devices to assist and stimulate the documentation process, with prompts and gently reminders that _software documentation_ is a form of care, not just a source of profit. +- A series of writing prompts to experiment with software documentation as a generative device to keep thinking through code from different perspectives. +- A way to understand publishing as iterative process, as a format that grows and shrinks through versioning and embrances branching to adapt to specific environments. + +- A (loose, habitable, extensible) map to orientate around what does it mean to _make software_ besides just writing code. -Research how writing software documentation changes depending on the context and actors involved. +- Something in between the refreshing shuffle of perspective in the Oblique Strategies, and the ability to infiltrate established practices like the Lottery of Babel. +- Something to be organized and shared as the Software Design Pattern, but to be discovered and performed as the Minecraft crafting system. -Experiment with software documentation as a generative device to keep thinking through code from different perspectives. +![Political compass of knowledge + references](compass_reference.jpg) -Explore software documentation as iterative process, as a format that grows and shrinks through versioning and embrances branching to adapt to specific environments. + ### How do you plan to make it? -Define a domain of research. Where does software documentation begin and where does it end? What about tutorials, guidelines, and demos? How porous or tentacular is this surface? +_note: the plan is to use the different hackpacts and assignments as a way to bootstrap different directions for the research. Every hackpact is self contained and in effect is a different prototype, but it rarelly ends when a new one starts. Rather, with every new hackpact the old ones continue developing in the background with less intensity, but in concert, informing each other._ + +`[Hackpact 1 - Define a domain of research]` + +Where does software documentation begin and where does it end? What about README files, tutorials, guidelines, comments in the source code, and demos? How porous or tentacular is this surface? Set some references by looking back at the works made last year and read them through the axis of code and care. Explore common templates of documentation and their habitability. + +#### Work on several prototypes and their documentation + +`[Hackpact 2 - Write documentation & focus on its contents and style]` + +Write documentation for selected prototypes from the many made last year: could this process create a new public, or transform their original ones? + +As initial case study focus on the Padliography, a tool developed within XPUB to keep track of the amount of scattered Etherpad documents used to take notes and work togheter. During last year it's been used only in the context of our class, but after some adjustments it's now flexible enough to be offered also to other constellations orbiting around the _XPUB & Lens-Based wiki_. + +What does it mean to offer it to someone else? How to talk the same language with different contexts? How to be clear without oversimplifying? + +`[Hackpact 3 - Write documentation & focus on the process of writing]` + +Open the writing process and experiment collaborative practices for the documentation of the Workbook, a tool developed together with Supi to keep track and annotate configurations for different instruments and facilitate learning process. + +Write the documentation together. Could there be multiple voices or is necessary to keep a single point of view? What does it mean to write with different intensities? Can we imagine ways to zoom in and out details level? How different knowledges can participate in this process? + +`[Hackpact 4 - Write documentation & focus on the surrounding context]` -Set some references by looking back at the works made last year and read them through the axis of code and care. Or some other system of coordinates that suits better. Could the process of writing documentation reactivate old prototypes, or cast different light onto them? +Expand the research to tap into ongoing projects outside XPUB, such as freelance work and parallel research such as [Object Oriented Choreography](../ooc-summer-session/), that is an ongoing project of mine related to networked technologies, VR and contemporary dance. -Expand the research to tap into ongoing projects outside XPUB, such as freelance works and [parallel research](../ooc-summer-session/). Are there ways to make the documentation process more sustainable? Are there strategies to overcome a low-resources environment? What are the relations between documentation and the communities around a software? +Are there ways to make the documentation process more sustainable (socially, economically)? Are there strategies to overcome low-resources environments? Search for escamotages to create space and energies to document. Use documentation to work with collaborators, clients, and end-users and approach code from multiple point of view. - +Try to infiltrate the industry of software development through documentation. Attempt to expose their public to these questions in subtle ways. Offer entry points and escape routes from the automatic outcomes proposed by tech solutionism. + +`[hackpact 5 - Write documentation & focus on who is writing it]` + +What are the relations between documentation and the community around a software? + +- Experiment with versioning. +- Try to have several instances of the same documentation. +- Try to question who is writing and who is reading the documentation. +- Shift the moment in which the documentation happens. +- Where the documentation is hosted? Question the nature of the documentation: what does it take for granted? For what kind of public it is produced, and what kind of public does it produce? How does it normalize the context around the software? What are its politics of access? How does it create entry points and how does it gatekeep? -Try to infiltrate the industry of software development through documentation. Attempt to expose their public to these questions in subtle ways. Offer entry points and escape routes from the universal solution proposed by big corporates. +`[hackpact 6 7 8 - Towards final project]` - +- Collect and organize the outcomes from the different hackpacts. +- Trace trends and synthetize common and diverting aspects. +- Research on a surface that could host this different facets. -### What is your timetable? +Is it a deck of cards? A table tennis setup with different prompts printed on different balls? Is it a game? A manifesto? A CMS? A trekking route or a 400km pilgrimage? -**October** +How can it inhabit the places where documentation is hosted? -Define a domain of research. Do not decide on it's granularity. +### What is your timetable? -Define the premises where which to ground the project by revisiting first year projects. +**October** -Think about a glossary and possible formats to test some concept in a small scale, such as the first public moment at Leeszal or the freelance works. +- Define a domain of research. +- Understand where to ground the project by revisiting first year prototypes. -Experiment writing the documentation for the [Padliography](https://hub.xpub.nl/soupboat/padliography/) and the [Workbook](https://hub.xpub.nl/soupboat/workbook/). +- Think about a glossary and possible formats to test some concept in a small scale, such as the first public moment at Leeszal. - +- Experiment writing the documentation for the [Padliography](https://hub.xpub.nl/soupboat/padliography/) and the [Workbook](https://hub.xpub.nl/soupboat/workbook/). **November** -Work on OOC for December performance at NaO Festival, Milan. What does it mean to document a bespoke tool developed just for this project? Experiment with the documentation for the interactive patch of OOC. - -Get in touch with key figures to interview for research. +- Experiment writing documentation for project outside XPUB, both artistic and commercial ones. +- Explore the moments in which the documentation happens. **December** -OOC performance in Milan. -Follow-up about the different documentation processes. -Gather material to have an historical overview of software documentation. +- What does scientific literature have to say about software documentation? +- Archeology of software documentation. From printed manuals to README files to CD/CI websites. **January** -Gather material to have a critical overview around software documentation. -Field research of the current state of software documentation. Explore different fields: big projects, small projects, corporate documentation and solo developers. Explore different languages and reflect on how they features are reflected in the documentation. -Experiment continuing writing the documentation for different prototypes. How does this process of writing documentation inform the process of writing the thesis? -Experiment with the idea of versioning, branching, collaborative writing. +- Field research of the current trends in software documentation. Explore different contexts (solo, coop, corporate, floss, proprietary) and different coding languages. + +- Follow up on the outcomes of the different hackpacts. Focus on + 1. materiality of the documentation (style, contents, forms), + 2. context around the documentation (actors, timeframe, hosting) **February** -Read read read and write write write. -Interview and case studies from different communities? -Experiment with the idea of versioning, branching, collaborative writing. +- Research and prototype possible formats for graduation project outcome. What surface could host this different factes together? +- 15 min daily prototypes starting from the sentence `A _________ to explore software documentation as a __________` **March** -Self-induce dreams about the final outcome with a follow-up on the thesis research. -Research and prototype possible formats for graduation project outcome. - -**April** +- Follow up on February daily prototypes +- **April** Production! Think about graduation exhibition and collective pubblication. @@ -121,19 +165,6 @@ Documenting software is a complex practice. Documenting software is a process of As a piece of code would write: I am documented, therefore I am. - - - - - - ### Who can help you and how? It would be interesting to get in touch with someone mantaining open source projects such as Paged.js, P5Js, vvvv. diff --git a/projects/graduation-divination/documentation.md b/projects/graduation-divination/documentation.md index 559d86e..f0a511d 100644 --- a/projects/graduation-divination/documentation.md +++ b/projects/graduation-divination/documentation.md @@ -133,3 +133,5 @@ Developing togheter with others it's a way to renegotiate priorities when develo [... staying low] --- + +And viceversa. Undocumented software is invisible, but for the eyes of their own developers. And eventually, it begins to fade as soon as the developer looks away. diff --git a/projects/grs/discord.jpg b/projects/grs/discord.jpg new file mode 100644 index 0000000..e132714 Binary files /dev/null and b/projects/grs/discord.jpg differ diff --git a/projects/grs/documentation.md b/projects/grs/documentation.md index 6362375..bc5e071 100644 --- a/projects/grs/documentation.md +++ b/projects/grs/documentation.md @@ -179,3 +179,66 @@ _some notes for the project:_ - Padliography category page on the wiki, with the same contents of the README.md and a list of the archives page. - Now when the padliography initialize a new archive, it adds the `[[category: padliography]]` tag, in order to list all the active archives in the category page. - Next step is: how to make it public? + +### 17th Oct + +Public event at Leeszaal: Gersande and me shared a table for discussing our intuitions with the public. It happened because G is working on the surface of the patent and I was super interested in drawing connections between that and the documentation. There were nice suggestions. Simon and Alice suggested to narrow down the audience, for example focusing on the use of documentation in the context of tech-coop. Need to have a look to the notes we collected through the ingenious carbon-copy notation system Grr and Kim developed. + +After the event and the discussion Naami sent me this incredible screen that is going directly into the thesis + +![Discord server fossil](discord.jpg) + +Thank you Naami! + +### 18th Oct + +- Sent some memes to the Piet in order to make the Padliography public (namely: clumsy frog pictures that point to the wiki page of the documentation. + +![frog 1](../padliography-2/Frog 01.jpg) + +![frog 2](../padliography-2/Frog 02.jpg) + +![frog 3](../padliography-2/Frog 03.jpg) + +![frog 4](../padliography-2/Frog 04.jpg) + +- Organize a public moment in PZI after the break. A monday morning session with the prototyping class? A Friday morning 1 hour worksiop / demo / user test? + +### 25th Oct + +- Prepare for the 31 Oct M&Ms + + - Presentation and demo - 10 min + - Documentation read and review exercise - 10 min + + - Mock product reviews??? + - Roleplay like X_Kitchen (from kim & chae) + - Your character is a customer / reader of this documentation + - Mobile form with written feedback + something funny like product picture or reaction + - title, review, pro / cons + something like a call to participate to the documentation (such as explain the tool with your own words, or similar) + - Review form: could be interesting to link it to the contents of the documentation (as a way to send feedback to the ones writing the doc) (to create a channel of communication?) + - + + - (simple form, store reviews in a small db, review different work ??? and an API to integrate the contents with real documentations) + +- Think about the documentation for the Workbook with Supi. There is a draft strucutre here [workbook documentation](https://pad.xpub.nl/p/modcms_documentation). + - imagine it in a way to coexhist with the aforementioned api ???? wtf did i just wrote aforementioned for real + +### M&Ms + +- Presentation of the Padliography: + + - Sorting table + - Filtering + - Add a new pad directly!! (m&ms) + - Init a new archive + - Add some pads (modcms, modcms_documentation) + - Switch between archives + +- Documentation of the Padliography + + - wiki + +- 10 min roleplay writing exercise + - read + review as you were on trip advisor or amazon + - short review + stars ⭐ diff --git a/projects/grs/trolley.html b/projects/grs/trolley.html new file mode 100644 index 0000000..51066ae --- /dev/null +++ b/projects/grs/trolley.html @@ -0,0 +1,111 @@ + + +
+ + + ++ Software comes from a really specific occidental cultural tradition. Software tends to + priviledge masculine, binary, exploitative and extractive practices. Software is + shrouded in technical obscurity. Software comes invisible, transparent, neutral. + Software models the world in order to control it. +
++ To make software means not only to write code, but also to take a stance regarding this + trends. To make software means not only to write code, but also to create a context and + community around it. +
++ Documentation is a space that interfaces the different actors around software. Software + documentation is a space with potential to renegotiate and reclaim given margins and + entry points. It is a chance to overwrite what is normalized, and let different + knowledges and voices participate in the discourse around software. +
+ ++ Documenting software is a complex practice. Documenting software is a process of + translation. Writing documentation it's more difficult than writing software itself. It + requires a lot of time and energy, and it involves many different skills: writing, + coding, knowing how to share and at which intensity. It's a collaborative practice that + could open to different voices. +
+As a piece of code would write: I am documented, therefore I am.
+ ++ Coding is not just production of software, but also production of knowledge. A dialogue + between human and more-than-human actors. The guestlist of this conference of the bits + is often compiled by chance: the choice of a particular programming language, the coding + style, the development environment and ecosystem, the infrastructure that runs the code, + and so on, are the result of specific contingencies. +
+ ++ These contingencies are situated in precise contexts, and these contexts are different + one from another. Programming is not just sharing code, but sharing context. Programming + means to provide a point of view and a perspective to look at the world, before + attempting to get some grip onto it with a script. That's the reason why even if source + code, even when obfuscated, speaks for itself, it cannot always cast light around its + surroundings. +
+ ++ To make place for code turns to be a necessary act of care in the process of sharing + knowledge. This does not mean to constrain the usage of some piece of software, or + provide opinionated solutions or tutorials, but rather letting others know where does + this code come from, and where it would like to go. +
+ ++ Documentation is a way to produce narrations around software. To create a world for a + software to inhabit, to give it affordances and stretch what is possible to do or to + think with it. Documentation is a space for the political of software. It's a surface + that could host ideas in close contact with codes, letting them entangle and shape each + other. +
+ +