#WriteTheDocs

Phil DavisI spent 3 hours "fixing" a feature that hadn't been documented sufficiently… in my own scripts. It is very well documented now.<a href="https://mastodon.nz/tags/techWriterLife" class="mention hashtag" rel="nofollow noopener" target="_blank">#techWriterLife</a> <a href="https://mastodon.nz/tags/technicalWriting" class="mention hashtag" rel="nofollow noopener" target="_blank">#technicalWriting</a> <a href="https://mastodon.nz/tags/writeTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#writeTheDocs</a>

Dysmorphia💛🤍💜🖤Haunted manuals lightning talkI gave a lightning <a href="https://sfba.social/tags/WriteTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#WriteTheDocs</a> in Portland, and in this post I share the recording and my slide deck.<a href="https://rinsemiddlebliss.com/posts/2025-05-16-haunted-manuals/" rel="nofollow noopener" translate="no" target="_blank">https://rinsemiddlebliss.com/posts/2025-05-16-haunted-manuals/</a><a href="https://sfba.social/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener" target="_blank">#TechnicalWriting</a>

Daniel D. BeckPulling back the moderation curtain a little bit with notes on how I ask people to correct their behavior, as a volunteer chat moderator for <a href="https://mastodon.social/tags/WriteTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#WriteTheDocs</a> <a href="https://ddbeck.com/notes/moderation-notice-checklist/" rel="nofollow noopener" translate="no" target="_blank">https://ddbeck.com/notes/moderation-notice-checklist/</a>

Phil DavisWhat about tech writers, Mr. Stephenson? "All technical devices require documentation […], but this stuff can only be written by the techies who are doing the actual product development, and they absolutely hate it, always put the dox question off to the very last minute. Then they type up some material […], run it off on the laser printer, send the departmental secretary out for a cheap binder, and that's that." Snow Crash, ch. 48<a href="https://mastodon.nz/tags/technicalWriting" class="mention hashtag" rel="nofollow noopener" target="_blank">#technicalWriting</a> <a href="https://mastodon.nz/tags/techWriterLife" class="mention hashtag" rel="nofollow noopener" target="_blank">#techWriterLife</a> <a href="https://mastodon.nz/tags/writeTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#writeTheDocs</a> <a href="https://mastodon.nz/tags/snowCrash" class="mention hashtag" rel="nofollow noopener" target="_blank">#snowCrash</a>

QUnitI'm drafting a diagram to explain how before/after hooks work in unit tests.They tend to work the same way across test frameworks, so it's not unique to QUnit. But, new devs will learn this for the first time, so I think it's worth explaining.Page: <a href="https://qunitjs.com/api/QUnit/module/#hooks" rel="nofollow noopener" translate="no" target="_blank">https://qunitjs.com/api/QUnit/module/#hooks</a>Issue tracker: <a href="https://github.com/qunitjs/qunit/issues/1358#issuecomment-2614663327" rel="nofollow noopener" translate="no" target="_blank">https://github.com/qunitjs/qunit/issues/1358#issuecomment-2614663327</a>What do you think?<a href="https://fosstodon.org/tags/qunit" class="mention hashtag" rel="nofollow noopener" target="_blank">#qunit</a> <a href="https://fosstodon.org/tags/WriteTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#WriteTheDocs</a> <a href="https://fosstodon.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener" target="_blank">#TechnicalWriting</a> <a href="https://fosstodon.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#SoftwareDocumentation</a> <a href="https://fosstodon.org/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#documentation</a> <a href="https://fosstodon.org/tags/devex" class="mention hashtag" rel="nofollow noopener" target="_blank">#devex</a>

Catalyst CooperativeWe're hiring a technical writer familiar with Python, Sphinx, <a href="https://fosstodon.org/@readthedocs" class="u-url mention" rel="nofollow noopener" target="_blank">@readthedocs</a> and hopefully also energy systems to help improve our <a href="https://mastodon.energy/tags/OpenData" class="mention hashtag" rel="nofollow noopener" target="_blank">#OpenData</a> docs. It's contract work and the writer doesn't need to be in the US. Please share & boost!<a href="https://catalyst.coop/work-with-us/technical-writer-pudl-season-of-docs/" rel="nofollow noopener" translate="no" target="_blank">https://catalyst.coop/work-with-us/technical-writer-pudl-season-of-docs/</a><a href="https://mastodon.social/@lzg" class="u-url mention" rel="nofollow noopener" target="_blank">@lzg</a> <a href="https://fosstodon.org/@yabellini" class="u-url mention" rel="nofollow noopener" target="_blank">@yabellini</a> <a href="https://mastodon.energy/@chrisnelder" class="u-url mention" rel="nofollow noopener" target="_blank">@chrisnelder</a> <a href="https://mastodon.energy/@jgkoomey" class="u-url mention" rel="nofollow noopener" target="_blank">@jgkoomey</a> <a href="https://fosstodon.org/@pyOpenSci" class="u-url mention" rel="nofollow noopener" target="_blank">@pyOpenSci</a> <a href="https://social.juanlu.space/@astrojuanlu" class="u-url mention" rel="nofollow noopener" target="_blank">@astrojuanlu</a> <a href="https://fosstodon.org/@okfn" class="u-url mention" rel="nofollow noopener" target="_blank">@okfn</a> <a href="https://fosstodon.org/@turingway" class="u-url mention" rel="nofollow noopener" target="_blank">@turingway</a> <a href="https://hachyderm.io/@thecarpentries" class="u-url mention" rel="nofollow noopener" target="_blank">@thecarpentries</a> <a href="https://social.coop/@luis_in_brief" class="u-url mention" rel="nofollow noopener" target="_blank">@luis_in_brief</a> <a href="https://social.coop/@brainwane" class="u-url mention" rel="nofollow noopener" target="_blank">@brainwane</a> <a href="https://mastodon.social/@grimalkina" class="u-url mention" rel="nofollow noopener" target="_blank">@grimalkina</a> <a href="https://mas.to/@kissane" class="u-url mention" rel="nofollow noopener" target="_blank">@kissane</a> <a href="https://mastodon.energy/tags/WriteTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#WriteTheDocs</a> <a href="https://mastodon.energy/tags/OpenSource" class="mention hashtag" rel="nofollow noopener" target="_blank">#OpenSource</a> <a href="https://mastodon.energy/tags/EnergyTransition" class="mention hashtag" rel="nofollow noopener" target="_blank">#EnergyTransition</a> <a href="https://mastodon.energy/tags/EnergyMastodon" class="mention hashtag" rel="nofollow noopener" target="_blank">#EnergyMastodon</a> <a href="https://mastodon.energy/tags/GetFediHired" class="mention hashtag" rel="nofollow noopener" target="_blank">#GetFediHired</a>

Kathy ReidDelighted to be able to publicise a paper that was presented at the @ALTAnlp 2023 Workshop at the end of last year, co-authored with my <a href="https://aus.social/tags/PhD" class="mention hashtag" rel="nofollow noopener" target="_blank">#PhD</a> supervisor, Associate Professor @eltwilliams, and written as part of my research at <a href="https://aus.social/tags/ANU" class="mention hashtag" rel="nofollow noopener" target="_blank">#ANU</a> School of Cybernetics. Titled "Right the docs: Characterising voice dataset documentation practices used in machine learning", it combines both exploratory interviews and documentation analysis to characterise how large voice datasets - e.g. <a href="https://aus.social/tags/LibriSpeech" class="mention hashtag" rel="nofollow noopener" target="_blank">#LibriSpeech</a>, <a href="https://mozilla.social/@mozilla" class="u-url mention" rel="nofollow noopener" target="_blank">@mozilla</a>'s <a href="https://aus.social/tags/CommonVoice" class="mention hashtag" rel="nofollow noopener" target="_blank">#CommonVoice</a>, and several others, document their <a href="https://aus.social/tags/metadata" class="mention hashtag" rel="nofollow noopener" target="_blank">#metadata</a>. Unsurprisingly, it finds that the <a href="https://aus.social/tags/dataset" class="mention hashtag" rel="nofollow noopener" target="_blank">#dataset</a> <a href="https://aus.social/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#documentation</a> practices seen currently do not meet the needs of the <a href="https://aus.social/tags/ML" class="mention hashtag" rel="nofollow noopener" target="_blank">#ML</a> practitioners who use these datasets.We show, once again, in the words of Nithya Sambasivan - "everyone wants to do the model work, but nobody wants to do the data work" ...<a href="https://aclanthology.org/2023.alta-1.6/" rel="nofollow noopener" translate="no" target="_blank">https://aclanthology.org/2023.alta-1.6/</a><a href="https://aus.social/tags/RightTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#RightTheDocs</a> <a href="https://aus.social/tags/WriteTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#WriteTheDocs</a>Citation: Reid, K., Williams, E.T., 2023. Right the docs: Characterising voice dataset documentation practices used in machine learning, in: Muresan, S., Chen, V., Casey, K., David, V., Nina, D., Koji, I., Erik, E., Stefan, U. (Eds.), Proceedings of the 21st Annual Workshop of the Australasian Language Technology Association. Association for Computational Linguistics, Melbourne, Australia, pp. 51–66.

DJ Fragile ToolchainsOK, so first life update is that I'm looking for work. Fully remote, perm or contract, senior docs or docs lead type stuff.Assorted relevant hashtags <a href="https://chaos.social/tags/writeTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#writeTheDocs</a> , <a href="https://chaos.social/tags/techWriting" class="mention hashtag" rel="nofollow noopener" target="_blank">#techWriting</a>, <a href="https://chaos.social/tags/docsAsCode" class="mention hashtag" rel="nofollow noopener" target="_blank">#docsAsCode</a>, <a href="https://chaos.social/tags/FediHire" class="mention hashtag" rel="nofollow noopener" target="_blank">#FediHire</a>, <a href="https://chaos.social/tags/API" class="mention hashtag" rel="nofollow noopener" target="_blank">#API</a>

Alex BallLooking for my next role as a <a href="https://hachyderm.io/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#documentation</a> manager or lead technical writer.I’m in British Columbia, Canada. Remote roles only.Check me out on LinkedIn (<a href="https://linkedin.com/in/polarweasel/" rel="nofollow noopener" translate="no" target="_blank">https://linkedin.com/in/polarweasel/</a>) and GitHub (<a href="https://github.com/polarweasel/" rel="nofollow noopener" translate="no" target="_blank">https://github.com/polarweasel/</a>)<a href="https://hachyderm.io/tags/FediJobs" class="mention hashtag" rel="nofollow noopener" target="_blank">#FediJobs</a> <a href="https://hachyderm.io/tags/GetFediHired" class="mention hashtag" rel="nofollow noopener" target="_blank">#GetFediHired</a> <a href="https://hachyderm.io/tags/FediHired" class="mention hashtag" rel="nofollow noopener" target="_blank">#FediHired</a> <a href="https://hachyderm.io/tags/JobSeeker" class="mention hashtag" rel="nofollow noopener" target="_blank">#JobSeeker</a> <a href="https://hachyderm.io/tags/WriteTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#WriteTheDocs</a>

Alex BallI got laid off this morning. I’ll have more to say later on after I process a little bit. Meanwhile, I’m looking for my next opportunity, and looking forward to leading another great team of technical writers as we <a href="https://hachyderm.io/tags/writethedocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#writethedocs</a>. <a href="https://hachyderm.io/tags/fedijobs" class="mention hashtag" rel="nofollow noopener" target="_blank">#fedijobs</a>

Fabrice FT<a href="https://pouet.chapril.org/tags/fosdem" class="mention hashtag" rel="nofollow noopener" target="_blank">#fosdem</a> is coming, and the <a href="https://pouet.chapril.org/tags/friday" class="mention hashtag" rel="nofollow noopener" target="_blank">#friday</a> before a <a href="https://pouet.chapril.org/tags/writethedocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#writethedocs</a> <a href="https://pouet.chapril.org/tags/toolthedocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#toolthedocs</a> <a href="https://pouet.chapril.org/tags/testthedocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#testthedocs</a> <a href="https://pouet.chapril.org/tags/prefosdem" class="mention hashtag" rel="nofollow noopener" target="_blank">#prefosdem</a> <a href="https://pouet.chapril.org/tags/meetup" class="mention hashtag" rel="nofollow noopener" target="_blank">#meetup</a> and <a href="https://pouet.chapril.org/tags/lunch" class="mention hashtag" rel="nofollow noopener" target="_blank">#lunch</a> <a href="https://www.meetup.com/Write-The-Docs-Berlin/events/290471112/" rel="nofollow noopener" translate="no" target="_blank">https://www.meetup.com/Write-The-Docs-Berlin/events/290471112/</a>

Sarah MoirIn terms of <a href="https://mstdn.social/tags/introductions" class="mention hashtag" rel="nofollow noopener" target="_blank">#introductions</a>, I'm an avid tech writer at work and often found writing blog posts and reading about music, data analysis, metadata, machine learning, data ethics, borders on the web, accessibility, inclusivity, and more. I'm a big fan of cultivating community so I stay aware of local politics + housing/transit/bike/pedestrian advocacy here in SF as well 🙃 <a href="https://mstdn.social/tags/writethedocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#writethedocs</a> <a href="https://mstdn.social/tags/technicalwriting" class="mention hashtag" rel="nofollow noopener" target="_blank">#technicalwriting</a> <a href="https://mstdn.social/tags/dataanalysis" class="mention hashtag" rel="nofollow noopener" target="_blank">#dataanalysis</a> <a href="https://mstdn.social/tags/machinelearning" class="mention hashtag" rel="nofollow noopener" target="_blank">#machinelearning</a> <a href="https://mstdn.social/tags/dataethics" class="mention hashtag" rel="nofollow noopener" target="_blank">#dataethics</a> <a href="https://mstdn.social/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#documentation</a>

Butter Over Too Much BreadSuppose I should give a re- <a href="https://vmst.io/tags/introduction" class="mention hashtag" rel="nofollow noopener" target="_blank">#introduction</a> for my second instance shuffle- I'm a <a href="https://vmst.io/tags/technical" class="mention hashtag" rel="nofollow noopener" target="_blank">#technical</a> <a href="https://vmst.io/tags/writer" class="mention hashtag" rel="nofollow noopener" target="_blank">#writer</a> by day - I <a href="https://vmst.io/tags/WriteTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#WriteTheDocs</a> - I work at <a href="https://vmst.io/tags/minio" class="mention hashtag" rel="nofollow noopener" target="_blank">#minio</a>, the object store - I like reading <a href="https://vmst.io/tags/fantasy" class="mention hashtag" rel="nofollow noopener" target="_blank">#fantasy</a> and <a href="https://vmst.io/tags/sci_fi" class="mention hashtag" rel="nofollow noopener" target="_blank">#sci_fi</a> - I'm a <a href="https://vmst.io/tags/dad" class="mention hashtag" rel="nofollow noopener" target="_blank">#dad</a> to three - I'm owned by two <a href="https://vmst.io/tags/cats" class="mention hashtag" rel="nofollow noopener" target="_blank">#cats</a> (a tabby and a tuxedo); they were pandemic kittens - I work from home, and like it that way - I <a href="https://vmst.io/tags/knit" class="mention hashtag" rel="nofollow noopener" target="_blank">#knit</a> things, mostly blankets - I'm a Next Gen <a href="https://vmst.io/tags/Trekkie" class="mention hashtag" rel="nofollow noopener" target="_blank">#Trekkie</a> - I watch <a href="https://vmst.io/tags/LOTR" class="mention hashtag" rel="nofollow noopener" target="_blank">#LOTR</a> extended editions at least yearly - I live in the mountains of north central Pennsylvania, and love it

FeorlenGuess I should do an <a href="https://appdot.net/tags/introduction" class="mention hashtag" rel="nofollow noopener" target="_blank">#introduction</a> again, hopefully connect with a few new folks interested in the same stuff. Hi New Folks! Welcome!Work: <a href="https://appdot.net/tags/startups" class="mention hashtag" rel="nofollow noopener" target="_blank">#startups</a> <a href="https://appdot.net/tags/cloud" class="mention hashtag" rel="nofollow noopener" target="_blank">#cloud</a> <a href="https://appdot.net/tags/infra" class="mention hashtag" rel="nofollow noopener" target="_blank">#infra</a> <a href="https://appdot.net/tags/observability" class="mention hashtag" rel="nofollow noopener" target="_blank">#observability</a> <a href="https://appdot.net/tags/techWriting" class="mention hashtag" rel="nofollow noopener" target="_blank">#techWriting</a>Fun: <a href="https://appdot.net/tags/handspinning" class="mention hashtag" rel="nofollow noopener" target="_blank">#handspinning</a> <a href="https://appdot.net/tags/weaving" class="mention hashtag" rel="nofollow noopener" target="_blank">#weaving</a> <a href="https://appdot.net/tags/knitting" class="mention hashtag" rel="nofollow noopener" target="_blank">#knitting</a> <a href="https://appdot.net/tags/fiber" class="mention hashtag" rel="nofollow noopener" target="_blank">#fiber</a> <a href="https://appdot.net/tags/textiles" class="mention hashtag" rel="nofollow noopener" target="_blank">#textiles</a> <a href="https://appdot.net/tags/sewing" class="mention hashtag" rel="nofollow noopener" target="_blank">#sewing</a>Online home: <a href="https://appdot.net/tags/AppDotNet" class="mention hashtag" rel="nofollow noopener" target="_blank">#AppDotNet</a> <a href="https://appdot.net/tags/ADN" class="mention hashtag" rel="nofollow noopener" target="_blank">#ADN</a> <a href="https://appdot.net/tags/WriteTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#WriteTheDocs</a> <a href="https://appdot.net/tags/selfHost" class="mention hashtag" rel="nofollow noopener" target="_blank">#selfHost</a> <a href="https://appdot.net/tags/MacOS" class="mention hashtag" rel="nofollow noopener" target="_blank">#MacOS</a> <a href="https://appdot.net/tags/Ubuntu" class="mention hashtag" rel="nofollow noopener" target="_blank">#Ubuntu</a>IRL home: <a href="https://appdot.net/tags/SFMission" class="mention hashtag" rel="nofollow noopener" target="_blank">#SFMission</a> <a href="https://appdot.net/tags/SanFrancisco" class="mention hashtag" rel="nofollow noopener" target="_blank">#SanFrancisco</a> <a href="https://appdot.net/tags/NorCal" class="mention hashtag" rel="nofollow noopener" target="_blank">#NorCal</a> <a href="https://appdot.net/tags/Loveland" class="mention hashtag" rel="nofollow noopener" target="_blank">#Loveland</a> <a href="https://appdot.net/tags/NoCo" class="mention hashtag" rel="nofollow noopener" target="_blank">#NoCo</a> <a href="https://appdot.net/tags/Colorado" class="mention hashtag" rel="nofollow noopener" target="_blank">#Colorado</a> <a href="https://appdot.net/tags/hempcrete" class="mention hashtag" rel="nofollow noopener" target="_blank">#hempcrete</a> <a href="https://appdot.net/tags/sustainability" class="mention hashtag" rel="nofollow noopener" target="_blank">#sustainability</a>

Derek | ScriptAutomateI really should get an <a href="https://fosstodon.org/tags/introduction" class="mention hashtag" rel="nofollow noopener" target="_blank">#introduction</a> out:Hey! I'm Derek. I love <a href="https://fosstodon.org/tags/opensource" class="mention hashtag" rel="nofollow noopener" target="_blank">#opensource</a>, <a href="https://fosstodon.org/tags/writethedocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#writethedocs</a>, <a href="https://fosstodon.org/tags/python" class="mention hashtag" rel="nofollow noopener" target="_blank">#python</a>, and running everything on <a href="https://fosstodon.org/tags/Linux" class="mention hashtag" rel="nofollow noopener" target="_blank">#Linux</a>.Are you a <a href="https://fosstodon.org/tags/ToolsForThought" class="mention hashtag" rel="nofollow noopener" target="_blank">#ToolsForThought</a> fan? I'm looking to follow people navigating <a href="https://fosstodon.org/tags/SecondBrain" class="mention hashtag" rel="nofollow noopener" target="_blank">#SecondBrain</a> and <a href="https://fosstodon.org/tags/DigitalGarden" class="mention hashtag" rel="nofollow noopener" target="_blank">#DigitalGarden</a> management of notes.I'm working on tools that can help make publishing easier, for me, using <a href="https://fosstodon.org/tags/LaTeX" class="mention hashtag" rel="nofollow noopener" target="_blank">#LaTeX</a> and Python/bash.I usually come up with weird projects since that's my primary way to learn something new, which I want to share more of.

Recent searches

Search options

Administered by:

Server stats: