From c682e2aa9ca0eae8d390c0dea96a1dc35c5acad1 Mon Sep 17 00:00:00 2001 From: kamo Date: Sat, 11 Feb 2023 02:58:42 +0100 Subject: [PATCH] intro homeworks --- chapters/.00_intro.md.swp | Bin 0 -> 16384 bytes chapters/00_intro.md | 17 +++++++++++++++++ chapters/01_who_is_reading.md | 2 +- 3 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 chapters/.00_intro.md.swp diff --git a/chapters/.00_intro.md.swp b/chapters/.00_intro.md.swp new file mode 100644 index 0000000000000000000000000000000000000000..8ecd89bc873a540f9fac46a419a9be2ef2c3e1f4 GIT binary patch literal 16384 zcmeI2OOG8#6~{Y436Llc!G?zfg)LzldG3sz1;#=e8RsC zy64Vi0elDe6zmC0*02MyVnHB@5UdGH9=~(C@0}Tfg_ISb9_jdAch}?8zy9Y@r*6LY zt%F-TQo*}3uBotxM0zxK%H z-Uv+Rq=tIuTFE6DT6 zb4dPlmRV%?sVtizfBjgNy^s9;qgnPhHYUPnIvM3#LHd5@yQyU5$f?~q?3 zze3(Zeu})0%6~zAkBI)iL4J$eXhO$_{+&O6-n<;5DczB)Ld$Orvh2aqSI!)mGMH}Z zn?wG!oqSCuy5wvumVBvf=aO0ZZfQDKEE`|g%B-UAe6vW#H^!Pg23wlsn&d9i-x=Gs zJSzBcgRxC%YS%48nG6rxkX&h&F4738L+YwEqs&9Bd6BQR|0=|a_BMu|?nNk>3pIqHADWqYuyhUTS$TKaw3V~TncUM}G~m}1buuZ;yA|_X7L6)2m##F9VG(V8*|@Hl znJ&l-Zf5R|tx#}FITPjsaGg8u3;@X7;bYcNX z8oqH*+l9Mj7rr?B&c$Wdwdwlqu9t@h4`(4Rc3Fu#p0&&N5}j?c86-4-DucXoaO=)V z@6~EGTll)wu9pV=iqI6U?X1{PL-$WJqS1zT?#&;KVe{-ADWf7!19dl<^c5T=j@1i`A4I7a1bF&V;X?@Z4 zVC6eA_lrJC$1^)^poVUcDmiXlO*2Yw!s>s&Yx2fwSF4>9MR9qhrRKF)0cJA~*( z=qsoQ10jTO3J-^r&_xAFc@5QyZeYHx76EvcHA}5rC){TcR~zADv%ri5!Nkva9E-(n z0&nBY+|cE-Zh9+qVM-t2d+MT+IROd`1=({=Xm(&vWKv<2S{`&wOW!hU-oqC zo6gs;I(MRoEm#VADynL zJAjpEcU?S!-IvYPy{lI*W!a0TZBO`ZO=`DD@{=W}z$P^6Ru01y9mJ{zf6ylvhi_Z| zGjL9tDK!PEVZ@a>2OwLy3cWEKKcC|-n$8>rU$}JL;MdH<9yMLF@QqVNPo5oPmmR8a zpOk&+(#Zr2ZHvPutSVP7gbN^QQxeQ8n*#>cRfu!S`E3?GPuw2%;TRYeWKC^-|*fN}q&&vaKG=Revxu2OV@ca<;+| zD|HzL(<<5JfuFt`@EpJs=`wjce0lwu0PQ z`%~|ZZ#S)tI0)a44p@~MoV-9C8Vo;oVAAM@2w|P<1;j6aXk)oLH|uZ}K7=tWyIZi- z6R(p8x^7&z+M#dy(5GrWEOH)0eTo&Q+;9T+t;r?d^~A32#EL0s6aqC;v&f;W=H=}+@>(<%^q(n<_x!V^K4lXWr>Eu z%(fC^+H@1s!C>97@7Bu3App75TwhvpomOT)EgC`QbSIhN2UV0^?@JO7ZMuT!+n88DG3y*`NX(1FHtu3un zhwo(^3$X`hT~!i^u_mxiwFE5brJjjjS2hc$?y(D@O2d>@5E~oj?b{(QVUsJH&{%XD zL74kvP#{{NU=EUpX+O&jB;2u&n?y$eB(161#HxiXN@s&VIn8A#V$I+oh_eIsl6Odg zB+#5Ios*Ee3PAp>L1Z;dXw8u=`o4y2cZQ@(A~)d3^3sWmCUUBG8bXG+j*};>|F~24O*SQ#OZ0;( zn6?spfLNmH>4-UO!5CZym6z=4ipUrjw!vv@ApRF$tebrCepLaK#J($ECY8cE!EBT0 z2}MFUG$asWR#>QnVK_|+(8*2>xj`@sCr*s`wTQmOJJJybX&z1RB-v_pQIa0<3R@fs#w+|J?X(cQ(#7#OIgFuoJl=c@e*o?Ml5?42s!{k=fV-MO9T5Bem>+dxsTnl zw9=lg_yfD>@%|FpLnDD;V9F4a^dM20x=-k)>0lWx@mW$*wgbN+`M@ToOClWw7V!%l zm!y@f2Z&gphQ+?J@l2?xa5_CHJ>=VrLrab;3l1K3<204R4zr7)k?%rPu$@QT(C7>| zVS(hiKb=?!E!g4E?8|9HRDm8_yF4*U6qU4TAVsuLOY>>LTAa&ve_5WU$%elj4YB(nfk&T}mXR5@{Ag#?Bnx*994i`^r}-+uA-b&dscocqAq zGdcgi#~J-o&vIPm{J**1{~7;(3;8Va8RXN5wi(aW)5nCsgusNrgusNrgusNrgusNr zgusNrguwp|0tW7*^{71F7c>Z^x!m Oh}<_9b5>bi%Kiy2z+Pkk literal 0 HcmV?d00001 diff --git a/chapters/00_intro.md b/chapters/00_intro.md index 1034013..ed74bc1 100644 --- a/chapters/00_intro.md +++ b/chapters/00_intro.md @@ -32,3 +32,20 @@ Documentation brings an understanding on software by disclosing its magic. It re Documentation is a space that interfaces between the code, the user, the developer, and the world. A space where to welcome different voices: not just engineers, not just experts, not just dudes. A space to acknowledge the massive labor of care besides technicalities, often marginalized by coding culture. A surface that could host principles in close contact with algorithms, letting them entangle and shape each other. A way to orientate our instruments towards "non-extractive relationships, but in the meantime, being accountable for the ones they are complicit with." (A Wishlist for Trans\*feminist Servers, 2022) + +--- + +## Homework + +### Software documentation + +While I do think that this research relates with technical writings in a broad sense, the approaches and methods proposed here are mostly informed by the worlds around coding documentation. When reading, please bind the terms software, application, program, etc. to code. Software documentation? Code documentation. The perspective of this text is more aligned to the docs of [ImageMagick](https://imagemagick.org/index.php) than to the ones of [GIMP](https://www.gimp.org/). The concepts of worlding, political aesthetic, and critical thinking apply to all kinds of manual. Nonetheless, it's probably going to be way easier to read this if you picture it figuring documentation for code and programming. + +### For developers + +I would like to blame the Capitalist Realism we are surviving in for this (probably not the case). For people to get identified with their profession. And the other way around: for activities being doomed by the aura of professionalism. Who is a developer? One who programs for a living or one who lives for programming? (based) + +Here a developer is someone tinkering with code. 1. one choose to participate 2. Expertise doesn't matter. Documentation is both a beginner and experienced user-friendly surface. + + + diff --git a/chapters/01_who_is_reading.md b/chapters/01_who_is_reading.md index dccf6e4..c606601 100644 --- a/chapters/01_who_is_reading.md +++ b/chapters/01_who_is_reading.md @@ -84,7 +84,7 @@ The potential of documentation to orientate software in the world clashes agains Writing documentation is demanding. It's more delicate than programming, and require a whole set of skills usually not treasured by the dev community. `(sorry this maybe is an overstatement, hope it is)` A kind of emotional intelligence and sensitivity far to be found in the competitive wastelands of the IT industry. Here no one wants to write documentation, nor hire someone to do it (Gabriel, 1996). As a result, in a world where software thrive, documentation still seems a scarce resource. -It's ok, someone could object, every problem that can be asked on Stack Overflow, will eventually be asked in Stack Overflow (paraphrasing Atwood, 2007). +It's ok, someone could object, every problem that can be asked on Stack Overflow, will eventually be asked in Stack Overflow (paraphrasing Atwood, 2007). and it's amazing to have communities that can solve every problems but then ppl encoded chauvinism, toxic masculinity, ...