diff --git a/txt/assessment.md b/txt/assessment.md index 0c987c9..420884e 100644 --- a/txt/assessment.md +++ b/txt/assessment.md @@ -1,4 +1,4 @@ -- software documentation is a form of care +- Software documentation is a form of care - that means - _1_ - **collect contents** @@ -10,4 +10,121 @@ - ![soup gen info](img/soup-gen.png) - Documentation and doubts can share the same space - ![soup gen doubt](soup-gen-q.png) -- + +
+ +- **situated software** +- the context is +- our group in xpub +- up to 20 participants (10 of us + tutors + guests) +- various background +- the main space where these software run is the Soupboat +- a server running on a rpi +- that hosts tools and prototypes +- a list of software +- here is an index +- and a general overview + +
+ +- _SI16 API_ + - Learning how to walk while catwalking + - _url_ [hub.xpub.nl/soupboat/si16/](https://hub.xpub.nl/soupboat/si16/) + - A set of functions to mess around with vernacular language processing + - Published as an API + - Sparse architecture + - A collective work where everyone contributed with some functions + - Written in Python through Jupiter Notebook + - And documented in the very same notebooks + - With description, examples and references about input and output + - And then aggregated together as endpoints for the API + - _example_ [Shout function](https://hub.xpub.nl/soupboat/si16/functions/shout/) + - A choral API + - with multiplayer approach to documentation + - More documentation for the backend is available + - _url_ [hub.xpub.nl/soupboat/~kamo/projects/si16-backend/](https://hub.xpub.nl/soupboat/~kamo/projects/si16-backend/) +- _SI17 post-it generator_ + - Generate pubblications in a post-it format + - get the contents from a shared repo on git + - _url_ [git.xpub.nl/kamo/post-it-contents](https://git.xpub.nl/kamo/post-it-contents) +- _Soup Generator_ +- _k-pub_ +- _Annotation Compass_ +- _Birthday card collector_ +- _Xquisite branch_ +- _workbook_ +- _textoscope_ +- _workinon_ +- _skimmer_ +- _wlist_ +- _tlist_ +- _bcard_ +- _Padliography2_ +- _kiwiboat_ +- _overture atlas_ +- _chaos puzzles_ +- _soupboat cms_ +- _flaskboat cms_ +- _spawn sticker_ +- _the parliament_ +- _diffractive cookbook_ + +
+ +- **brainstorm** +- list of software +- with overview +- where to find the documentation +- how to contribute writing +- other references for the proj +- _tag_ +- software +- what +- where +- doc +- links +- dev + +
+ +- _example_ +- (workbook) +- [what] +- A tool to keep track and annotate configurations for different instruments +- to facilitate learning process +- [where] +- https://hub.xpub.nl/soupboat/workbook/ +- [doc] +- https://hub.xpub.nl/soupboat/workbook/documentation +- https://pad.xpub.nl/p/modcms_documentation +- draft in progress +- [dev] +- main repo +- https://git.xpub.nl/supisara/workbook +- svg to interactive panel +- https://git.xpub.nl/kamo/panel +- cables system +- https://git.xpub.nl/kamo/spaghetti +- [links] +- brainstorming pad +- https://pad.xpub.nl/p/modcms +- [refs] +- reference for spaghetti cables system +- https://hub.xpub.nl/soupboat/~kamo/projects/spaghetti/ +- reference for interactive panel generator +- https://hub.xpub.nl/soupboat/~kamo/projects/panel/ +- (padliography2) + +
+ +- a mix between a TOML config file and a list +- seems mainly a series of links +- that is ok +- navigation is done through [tag]s +- that could be used to parse the list +- so in the end is a text-based 1D CMS +- soft framework +- with minimal hierarchy +- (round brackets for the software) +- aka title of the section +- [square brackets for the tags] diff --git a/txt/small.md b/txt/small.md new file mode 100644 index 0000000..bcfbc9f --- /dev/null +++ b/txt/small.md @@ -0,0 +1,21 @@ +- a small software pubblication +- that is a framework to manage software documentation +- in which sense is a framework? +- it facilitates to keep track of the software used in a community and related documentation +- which workflow? +- it could be a flat cms +- 1D cms +- like a tape +- like that work from pepe + +
+ +- a software pubblication +- contents: +- documentations of our software +- approaches and references +- techniques and excercise + +- in a way it's a reader + +- it's for internal use