kamo
/
writing-list
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
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.
master
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b38f3594bc'
${ noResults }
writing-list/txt/doc.md

11 KiB
Raw Blame History Unescape Escape

first round

  • list of documentation related things done so far
  • in no particular order


second round

  • sort things out a bit






third round

  • emerging patterns
  • great interest in developing tools & writing machines
  • lot of them
  • often with (half-baked) documentation
  • or with documentation that could be further inflated
  • with new eyes so to say after thes

  • idea
  • a toolkit of writing machines
  • created in the context of the soupboat
  • with curated documentation
  • that offers not only reference on how to use the writing machines
  • but also provides context around specific choices made during development
  • a way to use code documentation to flesh worlds around these tools

  • sections

  • context: soupboat

  • index of writing machines

  • documentation for every writing machine

  • thoughts around document situated software

  • thoughts around future of the soupboat

  • focus points for selection

  • what worked

  • what didnt


  • outputs
  • digital
  • website?
  • (admittedly im a bit bored of that)
  • see opening of wlist readme
  • "A small writing machine to experiment the list format. It’s again web-to-print, it’s again flask, it’s again markdown, it’s again it’s again it’s again. I’m 30% sorry."
  • (that could be a nice trigger )
  • but it's probably the most viable option
  • could it be something different??
  • really inspired by soft serve
  • publishing through ssh
  • charm.sh
  • physical
  • could make use of all the things learned with birds press, catalog
  • would be nice to have something that fit the shop format
  • or even just a small pubblication
  • legs

  • grad show
  • i have contrasting feelings about exhibiting something on a computer
  • at the same time it's easier to relate with a writing machine and its surroundings hands-on
  • but the entry point through which relate for the audience could not be in the writing machine, but in the documentation
  • that makes sense
  • the whole point of this toolkit is to bring documentation practices in foreground
  • the tools are more like supports to sustain this continuous thinking process
  • like legs 👀
  • like 3d printed legs such as the ones for the soupboat

round 4

  • publishing a series of readme files

  • of significative documentations

  • (significative for different reasons!)

  • (style, writing methods, contents, etc.)

  • for writing machines developed in the context of the soupboat

  • additional focus points:

  • thoughts around document situated software

  • thoughts around future of the soupboat


  • padliography -> situated software
  • workbook -> collaborative
  • exquisite branch / exex -> versioning
  • si16 -> multi author

  • padliography

  • what's there

  • intro

  • catchy features!

  • quick start

  • how does it work / ecosystem

  • development

  • license

  • what's missing

  • from where it comes from

  • serve behind reverse proxy

  • updated api documentation

  • interaction with the wiki

    • deleting by accident chae's pages in the wiki

  • choices made in development:

    • vue?
    • wiki?
    • beautiful soup?
    • hosting and hospitality
    • multiple tables

  • situated?

    • constant padology is a good reference to create a context
    • default pages
    • environmental variable and credentials for the wiki

  • future?

    • example: installing it on the breadcube

  • workbook

  • developed together with supi!!!

  • so also could be a place to try pair documenting

  • what's there

  • intro and overview

  • add instrument

  • export from Figma

  • export from inkscape

  • what's missing

  • what + why / intentions

  • add patch

  • add snippet

  • clone / development

  • code documentation and tool documentation blend

  • choices made in development:

    • custom instruments
    • flexibility accessibility performance goat

  • situated?

  • future?

  • collaborative?


  • xbranch exex

  • exex is a version of xbranch

  • no documentation at all for xbranch

  • started documenting

  • what is there

  • intro

  • install

  • overview

  • what is missing

  • development

  • serve behind reverse proxy

  • documentation from the api

  • examples!

  • background behind development? previous versions?

  • situated?

  • future?

  • versioning?


  • ok plan is to start these and then see what happens

round 5

  • to make your code run faster

  • to make your code run everywhere

  • to make your code run amok

  • what is it?

  • a series of small pubblications

  • readme files

  • for code developed around the soupboat

  • with 3d printed legs

  • to make them run faster

  • optional: could include thesis

  • imagine it as an ecosystem

  • with different zones

  • soupboat

  • wiki

  • git

  • browser

  • real people

  • every code is situated different in this ecosystem

  • in ways that are too complex to explain precisely outside the documentation

  • but can be depicted easily using a mapping approach

  • it also does not need to be super precise

  • and can be playful enough to lure people in

  • while at the same time offer an intuitive way of how these software are oriented in the world


  • 3d legs sketch
  • start from soupboat's legs
  • target an A6 pubblication
  • 148x105mm
  • with hard cover where to plug the legs
  • even on the fly
  • with a drilling machine
  • and a lock system to attach the legs
  • composables
  • 2 or 3 kind of legs that can be combinated
  • straight
  • L shaped

round 6

  • Try this simple trick to make your server run 4x faster
  • to make your code run faster
  • and other code documentation attempts
  • a collection of readme files
  • accessible through a website
  • website is a hub that links to the repo
  • in order to access the files directly in their natural environment

  • how to make your server run 4x faster
  • and other placeholder code documentation placeholder
  • open your terminal and enter the following command
  • curl -O https://projects.xpub.nl/how-to-make-your-server-run-4x-faster/legs.stl
  • this will save an stl file with 4x legs in your working directory
  • 3d print the two pairs of legs and install them on your server
  • note: remember to adjust the size of the 3d printed file to fit with the dimensions of your server!
  • this specs are tailored to a small self-hosted Raspberry Pi 4
  • if your server is running on a different piece of hardware things could need an adjustment
  • however it's not in the scope of this documentation to cover all possible cases
  • reboot and congratulations
  • your server now run 4x faster

  • then a transition to create some context for the work
  • research about code documentation
  • link to thesis
  • and then links to different readme files in their repo
  • organized with the idea of pathways explored here

  • then bio
  • link to soupboat
  • pictures from the exhibition setup with the small creatures pubblications going around
  • and that's it

round 7

  • project description can be the link between intro tutorial and the project itself
  • one small paragraph that says things such as
  • documentation as practice
  • bring documentation practices more close to programming ones
  • hellow orlding hello worlding hell o worlding