diff --git a/03/index.html b/03/index.html index 816a67a..d0affb3 100644 --- a/03/index.html +++ b/03/index.html @@ -10,34 +10,58 @@

doc doc doc

documenting code documentation
hello! welcome. this is an archive to navigate trough documentation practices
-
pair programming and pair reading.
+
pair programming and pair documenting
-

- The practice of pair programming involves two developers coding together on the same machine, with distinct roles. The driver writes the actual code, while the navigator reviews each entry along the way. - Roles are often switched. - Developers with similar or different experience can collaborate in pair programming, with benefits for both parts. -

+

+ The practice of pair programming involves two developers coding together on the same machine, with distinct roles. The driver writes the actual code, while the navigator reviews each entry along the way. + Roles are often switched. + Developers with similar or different experience can collaborate in pair programming, with benefits for both parts. +

-

- Could the concept of pair programming be applied to documentation? -

+

+ Navigating through documentation can be difficult. + Could the concept of pair programming be applied to documentation? +

-

pair documentation writing: one writes and the other provides perspective, such as reviewing if there are parts that are not clear

-

pair documentation reading: one read and the other ???

+

pair documentation writing: one writes and the other provides perspective, such as reviewing if there are parts that are not clear

+

pair documentation reading: one read and the other ???

-

experiments with pair doc writing together with chae for the flask example repo, that led to a more welcoming and vernacular way of writing

+

experiments with pair doc writing together with chae for the flask example repo, that led to a more welcoming and vernacular way of writing

+

what could it mean to read documentation in pair?

-

what could it mean to read documentation in pair?

+
+ + +
+ + +

Documentation is not just for beginners, is a code companion. One never stops reading. Both newcommers and experienced developers alike read documentation, that meets them in different moment of their programmer lives, from the hello world to the how to uninstall

+ +

when pairing reading make sense? which kind of situations?

+ +

im struggling because all of these things are activities and not objects and this cause me disconfort

+ +
+ +
+ + diff --git a/04/index.html b/04/index.html new file mode 100644 index 0000000..39daf31 --- /dev/null +++ b/04/index.html @@ -0,0 +1,73 @@ + + + + + 04 - Tree + + + +
+

doc doc doc

+
documenting code documentation
+
+ hello! welcome. this is an archive to navigate trough documentation practices +
+
+

+ The path through documentation resources in the making of a project could be represented as a tree structure, where the root is the project idea or need and then branches all the explored direction and lateral resources. +

+

+ Tree structures recall hierarchy, because of the different structural positions of branches and leaves. However what I'm interested here is the temporality of the tree. There is a starting point, a root, and then different tryouts, with dead ends, ramifications, different experiments. +

+

+ An example is undo-tree where instead of the linear approach of ctrl-z, a fluorishing history of attempts is preserved. +

+
+ + +
+ +
+

+ So the plan is: keep track of your path. Start from something (could be an idea for a project, a need for understanding, the writing of some documentation) and then keep track of the various resources encountered through time in a tree-like structure. +

+ +

+ This excercise seems flexible enough to host different approaches and materials. Could be an history of navigation through hyperlinks, but also contain reflections and snapshots of how the initial idea changes during time. Ideally every node of the tree could be a potential entry point / backdoor to reflect on documenting practices. +

+ + +

+ It could be tried in alone or in group, with one or many trees. To have a less linear and more entangled structure. It could host practices such as the one of 03 - Pair, where one driver go through and the navigator map into the tree. +

+ +
+ + + + +
+ + + +

Prototype +

+ +
+

+ Comparative Iceberg Studies +

+

+ Write a image scraper to download a bunch of picture from the iceberg meme template (that maps facts about a topic from the tip, common knowledge, to the bottom, esoteric, misterious, unknown details). Group the image and align all of them. Call people within the field of each topic and make them comment the result. Edit and bound. +

+
+ +
+ + + +