## first round - list of documentation related things done so far - in no particular order
- [tag experiments](https://hub.xpub.nl/soupboat/tag/) - [tag git](https://git.xpub.nl/kamo/tag) - [01 Pathways](https://hub.xpub.nl/soupboat/tag/01/) - [02 Openings](https://hub.xpub.nl/soupboat/tag/02/) - [03 Pair](https://hub.xpub.nl/soupboat/tag/03/) - [04 Tree](https://hub.xpub.nl/soupboat/tag/04/) - [Writing Machines](https://hub.xpub.nl/soupboat/wm/) - [exex example](https://hub.xpub.nl/soupboat/wm/entries/exex/) - [Writing Machines doc page](https://hub.xpub.nl/soupboat/~kamo/projects/writing-machines/) - [voicing doc - open call radio worm](https://git.xpub.nl/kamo/docr) - Hello worlding - Code documentation as entry point / backdoor to programming practices (thesis) - [documentation sessions](https://hub.xpub.nl/soupboat/docs/) - [documentation sessions @varia](https://varia.zone/en/code-documentation.html) - [doc ses @soupboat](https://hub.xpub.nl/soupboat/~kamo/projects/dyc/) - [doc ses @git](https://git.xpub.nl/kamo/dyc) - [bonfire - flat markup documentation language](https://hub.xpub.nl/soupboat/bonfire/) - [bonfire git](https://git.xpub.nl/kamo/bonfire) - [dlist git - prototype for flat markup lang](https://git.xpub.nl/kamo/dlist) - from here is more documentation for writing machines - [pad-bis docs](https://git.xpub.nl/kamo/pad-bis) - [wlist (this page!) docs](https://git.xpub.nl/kamo/wlist) - made me think that an excercise for today would be: to inflate a documentation, providing context for different choices that were made - [exex - git](https://git.xpub.nl/kamo/exex) - [exex - exquisite excerpts](https://hub.xpub.nl/soupboat/exex/) - [exex - docs](https://hub.xpub.nl/soupboat/exex/display/about/) - [drw - git](https://git.xpub.nl/kamo/drw) - [drw - workshop](https://hub.xpub.nl/soupboat/~kamo/projects/ws-js-ws/) - [textoscope - text intensities with xml](https://git.xpub.nl/kamo/textoscope) - [textoscope - text intensities with xml](https://git.xpub.nl/kamo/textoscope) - [workinon - documentation as snapsoht](https://hub.xpub.nl/soupboat/workinon/) - [workinon - git](https://git.xpub.nl/kamo/workinon)
## second round - sort things out a bit
- _writing machines_ - [bonfire - shared documentation surface](https://hub.xpub.nl/soupboat/bonfire/) - [1dl - flat markup language](https://git.xpub.nl/kamo/dlist) - [padliography](https://hub.xpub.nl/soupboat/padliography/) - [exex - exquisite excerpts](https://hub.xpub.nl/soupboat/exex/) - [textoscope - text intensities with xml](https://git.xpub.nl/kamo/textoscope) - [wlist - writing list machine](https://hub.xpub.nl/soupboat/wlist/) - [Pair Documenting](https://hub.xpub.nl/soupboat/tag/03/) - [Tree](https://hub.xpub.nl/soupboat/tag/04/)
- _documentation_ - [thoughts about documentation session](https://hub.xpub.nl/soupboat/~kamo/projects/dyc/) - [writing list docs](https://git.xpub.nl/kamo/writing-list) - [padliography wiki](https://pzwiki.wdka.nl/mediadesign/Padliography) - [exex - docs](https://hub.xpub.nl/soupboat/exex/display/about/) - [wm/exex example](https://hub.xpub.nl/soupboat/wm/entries/exex/)
- _archives_ - [soupboat](https://hub.xpub.nl/soupboat/) - [documentation workout](https://hub.xpub.nl/soupboat/~kamo/) - [Pathways](https://hub.xpub.nl/soupboat/tag/01/) - [tag experiments](https://hub.xpub.nl/soupboat/tag/) - [Writing Machines](https://hub.xpub.nl/soupboat/wm/) - [Writing Machines doc page](https://hub.xpub.nl/soupboat/~kamo/projects/writing-machines/)
- _workshops_ - [documentation sessions](https://hub.xpub.nl/soupboat/docs/) - [documentation sessions @varia](https://varia.zone/en/code-documentation.html) - [drw - workshop](https://hub.xpub.nl/soupboat/~kamo/projects/ws-js-ws/)
- _writings_ - [Hello worlding - Code documentation as entry point / backdoor to programming practices](https://hub.xpub.nl/soupboat/~kamo/thesis/) (thesis) - [Openings](https://hub.xpub.nl/soupboat/tag/02/) - [voicing doc - open call radio worm](https://git.xpub.nl/kamo/docr)
- _repo_ - [tag](https://git.xpub.nl/kamo/tag) - [workinon](https://git.xpub.nl/kamo/workinon) - [textoscope](https://git.xpub.nl/kamo/textoscope) - [doc ses](https://git.xpub.nl/kamo/dyc) - [bonfire](https://git.xpub.nl/kamo/bonfire) - [dlist - prototype for flat markup lang](https://git.xpub.nl/kamo/dlist) - [wlist - writing list](https://git.xpub.nl/kamo/writing-list) - [exex](https://git.xpub.nl/kamo/exex) - [drw ](https://git.xpub.nl/kamo/drw) - [pad-bis](https://git.xpub.nl/kamo/pad-bis) ## 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](https://charm.sh/) - _physical_ - could make use of all the things learned with [birds press](https://hub.xpub.nl/soupboat/~kamo/projects/birds-press/), [catalog](https://git.xpub.nl/kamo/birds-press) - 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