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.

2.0 KiB

  • what do you want to make?
  • a small documentation framework
  • focused on the development of situated software
  • in the context of our group in XPUB

  • our group
  • up to 20 participants
  • 10~ students + tutors + guests
  • coming from various backgrounds
  • rich and diverse approach to coding
  • small community!

  • our ecosystem
  • the main space where these software run is the Soupboat
  • a self-hosted server running on a Raspberry Pi
  • homing tools and prototypes
  • url hub.xpub.nl/soupboat
  • the main space used to document things is the wiki
  • along with scattered etherpad documents
  • and sometimes git
  • url pzwiki.wdka.nl
  • url pad.xpub.nl
  • url git.xpub.nl

  • So is this just a documentation of the Soupboat?
  • yes
  • no
  • it's two things
  • it starts as documentation around the Soupboat
  • to develop a documentation framework for situated software
  • like the chicken-egg meme

  • docs
  • a soft index of our software
  • what do they do
  • where to find them
  • how to use them
  • from where they come from
  • and where they are going
  • how we are documenting them
  • how to contribute
  • why are they important for us

  • framework
  • develop ways to document
  • our system of software & practices
  • flexible and expressive enough
  • to be useful for us
  • and accessible for others
  • a list of resources
  • a way to articulate code as common
  • and documentation as a form of care

  • why?

  • 1

  • more documentation

  • more participation

  • 2

  • documentation as interface between

  • code

  • user

  • developer

  • world

  • 3

  • contradiction betwen

  • being frustrated in having to deal with undocumented piece of software

  • and a the same time never documenting anything+


  • Documentation is a space that interfaces between the code, the user, the developer, and the world.