{"id":467,"date":"2023-02-06T19:52:26","date_gmt":"2023-02-07T00:52:26","guid":{"rendered":"https:\/\/redmonk.com\/kfitzpatrick\/?p=467"},"modified":"2023-02-06T19:52:26","modified_gmt":"2023-02-07T00:52:26","slug":"documentation-the-bridgework-of-oss","status":"publish","type":"post","link":"https:\/\/redmonk.com\/kfitzpatrick\/2023\/02\/06\/documentation-the-bridgework-of-oss\/","title":{"rendered":"Documentation: the Bridgework of OSS"},"content":{"rendered":"<p><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter size-large wp-image-468\" src=\"http:\/\/redmonk.com\/kfitzpatrick\/files\/2023\/02\/DAI-Bridgework-of-OSS-Thumbnail-1024x580.jpg\" alt=\"Title card for The Docs Are In episode on Documentation: the Bridgework of OSS, with screenshots of the three speakers\" width=\"1024\" height=\"580\" srcset=\"https:\/\/redmonk.com\/kfitzpatrick\/files\/2023\/02\/DAI-Bridgework-of-OSS-Thumbnail-1024x580.jpg 1024w, https:\/\/redmonk.com\/kfitzpatrick\/files\/2023\/02\/DAI-Bridgework-of-OSS-Thumbnail-300x170.jpg 300w, https:\/\/redmonk.com\/kfitzpatrick\/files\/2023\/02\/DAI-Bridgework-of-OSS-Thumbnail-768x435.jpg 768w, https:\/\/redmonk.com\/kfitzpatrick\/files\/2023\/02\/DAI-Bridgework-of-OSS-Thumbnail-1536x870.jpg 1536w, https:\/\/redmonk.com\/kfitzpatrick\/files\/2023\/02\/DAI-Bridgework-of-OSS-Thumbnail-480x272.jpg 480w, https:\/\/redmonk.com\/kfitzpatrick\/files\/2023\/02\/DAI-Bridgework-of-OSS-Thumbnail-426x242.jpg 426w, https:\/\/redmonk.com\/kfitzpatrick\/files\/2023\/02\/DAI-Bridgework-of-OSS-Thumbnail-1107x627.jpg 1107w, https:\/\/redmonk.com\/kfitzpatrick\/files\/2023\/02\/DAI-Bridgework-of-OSS-Thumbnail.jpg 1925w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/p>\n<p>If you are interested in the prospect of creating a \u201cculture of docs\u201d in open source software (OSS) communities&#8211;or if you just love civil engineering metaphors&#8211;<a href=\"https:\/\/www.youtube.com\/watch?v=BzyC0wX1UNw\">this The Docs Are In episode<\/a> is for you. This time around <a href=\"https:\/\/redmonk.com\/team\/kate-holterhoff\/\">Kate<\/a> and I interview Abigail McCarthy, who has some very fancy titles: 1) Staff Technical Open Source Communications Manager at VMware and 2) <a href=\"https:\/\/kubernetes.io\/docs\/contribute\/participate\/\">Kubernetes SIG Docs<\/a> Localization Subproject Lead. Abbie landed at VMware through its acquisition of Heptio (a company built around <a href=\"https:\/\/kubernetes.io\/\">Kubernetes<\/a>), and describes her day job as such:<\/p>\n<blockquote><p>What I try to do in my day to day job is to help open source communities build out docs communities and docs culture within their open source projects. So figuring out processes, trying to help get people involved, actually creating the docs on time for release. So going through all that process and really being an advocate for documentation within open source communities.<\/p><\/blockquote>\n<p>We then jump into how Abbie got into tech writing (TL;DR: \u201caccidentally\u201d), and it is worth noting that I had the great privilege of working with Abbie at her first tech writing gig at Apprenda (where she began engaging with the Kubernetes community). Having both Abbie and Kate (who I worked with in our pre-Monk days at Georgia Tech) in the same docs-related conversation was an absolute delight for me, and we cover a LOT of ground in the remainder of the conversation:<\/p>\n<ul>\n<li aria-level=\"1\">Actual writing is the part of tech writing Abbie likes least; she prefers figuring out how all the things work, how all the pieces fit together, and sees writing as the output of these processes.<\/li>\n<li aria-level=\"1\">Documentation as an avenue into OSS and Abbie\u2019s own path from an OSS \u201clurker\u201d to active community member. Abbie also recounts witnessing early on how the Kubernetes SIG Docs group went through the process of setting things up; she saw first-hand what works, what doesn\u2019t, how to be inclusive, and how to set up an environment that people want to be a part of.<\/li>\n<li aria-level=\"1\">Abbie\u2019s trip to KubeCon in Detroit this past October, where she got to interact with members of the Kubernetes community \u201coutside of the Zoomscape\u201d and was delighted to see \u201chow engaged folks in the community are with documentation.\u201d<\/li>\n<li aria-level=\"1\">Some of the challenges Abbie has run into with OSS docs, which include getting and keeping folks involved with OSS documentation.<\/li>\n<\/ul>\n<p>On this last point, Abbie calls out the importance of creating \u201cbridges\u201d to help get folks&#8211;especially writers&#8211;more comfortable engaging with OSS projects:<\/p>\n<blockquote><p>I think there could also be some more general advocacy and outreach to technical writing communities to get folks a little more engaged. And I think there might be a little more pieces to do \u2014 a little more bridge work to get folks who maybe don\u2019t have as technical of a background more help within certain projects to get to the point where they feel more comfortable engaging in a more long term, sustainable way.<\/p><\/blockquote>\n<p>We then get to the importance of creating a \u201cculture of docs,\u201d which Abbie describes as such:<\/p>\n<blockquote><p>To keep documentation on par with all of the project work you are doing \u2014 being the code work that you are doing&#8211;so that you can make sure that all of these pieces go together and they all have kind of a through line so that when you get to your release or get to wherever you are, you\u2019ll be able to present your users or be able to remember yourself what was happening when you were doing something along the way.<\/p><\/blockquote>\n<p>She then elaborates on how influential this can be on the larger community:<\/p>\n<blockquote><p>I like the idea of creating a culture&#8211;a positive culture&#8211;and it\u2019s not a chore because a lot of times some people have that perception that documentation is a chore or an afterthought. But if you start it right from the beginning and say, \u201cThese are the things that are important to our project,\u201d it will just become ingrained in the layout of your community anyway and just become a part of how people work within your community.<\/p><\/blockquote>\n<p>I love the concept of a \u201cculture of docs\u201d and also that a project as successful as Kubernetes has created a strong docs culture within its larger community (and managed to bring a documentarian like Abbie into the fold).<\/p>\n<p>You can watch the video of this conversation below or see <a href=\"https:\/\/redmonk.com\/videos\/the-docs-are-in-documentation-the-bridgework-of-oss\/\">the full transcript and related links<\/a>.<\/p>\n<p><span class=\"embed-youtube\" style=\"text-align:center; display: block;\"><iframe class='youtube-player' width='640' height='360' src='https:\/\/www.youtube.com\/embed\/BzyC0wX1UNw?version=3&#038;rel=1&#038;showsearch=0&#038;showinfo=1&#038;iv_load_policy=1&#038;fs=1&#038;hl=en-US&#038;autohide=2&#038;wmode=transparent' allowfullscreen='true' style='border:0;' sandbox='allow-scripts allow-same-origin allow-popups allow-presentation'><\/iframe><\/span><\/p>\n<p><b>Disclosure<\/b>: VMware is a RedMonk client; however, this post and the RedMonk video mentioned in this post were not commissioned by any entity.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>If you are interested in the prospect of creating a \u201cculture of docs\u201d in open source software (OSS) communities&#8211;or if you just love civil engineering metaphors&#8211;this The Docs Are In episode is for you. This time around Kate and I interview Abigail McCarthy, who has some very fancy titles: 1) Staff Technical Open Source Communications<\/p>\n","protected":false},"author":47,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"spay_email":"","footnotes":"","jetpack_publicize_message":"","jetpack_is_tweetstorm":false},"categories":[4,26,83],"tags":[44,40,80],"class_list":["post-467","post","type-post","status-publish","format-standard","hentry","category-tech-comm","category-tech-culture","category-video-recap","tag-documentation","tag-open-source","tag-vmware"],"jetpack_featured_media_url":"","jetpack_publicize_connections":[],"jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/redmonk.com\/kfitzpatrick\/wp-json\/wp\/v2\/posts\/467","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/redmonk.com\/kfitzpatrick\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/redmonk.com\/kfitzpatrick\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/redmonk.com\/kfitzpatrick\/wp-json\/wp\/v2\/users\/47"}],"replies":[{"embeddable":true,"href":"https:\/\/redmonk.com\/kfitzpatrick\/wp-json\/wp\/v2\/comments?post=467"}],"version-history":[{"count":0,"href":"https:\/\/redmonk.com\/kfitzpatrick\/wp-json\/wp\/v2\/posts\/467\/revisions"}],"wp:attachment":[{"href":"https:\/\/redmonk.com\/kfitzpatrick\/wp-json\/wp\/v2\/media?parent=467"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/redmonk.com\/kfitzpatrick\/wp-json\/wp\/v2\/categories?post=467"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/redmonk.com\/kfitzpatrick\/wp-json\/wp\/v2\/tags?post=467"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}