Mathstodon

QUnitEver wondered how beforeEach works in unit test frameworks? Check out our new lifecycle diagram!<a href="https://qunitjs.com/lifecycle/" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://qunitjs.com/lifecycle/</a>People generally guess right when it comes to ordering, so why a diagram?We want to show that the order is guaranteed, and showcase what's possible when you depend on it.Thanks to FND, Jan, and NullVoxPopuli for improving and promoting this work! H/T <a href="https://hachyderm.io/@FND" class="u-url mention" rel="nofollow noopener noreferrer" target="_blank">@FND</a> <a href="https://hci.social/@simulo" class="u-url mention" rel="nofollow noopener noreferrer" target="_blank">@simulo</a> <a href="https://mastodon.coffee/@nullvoxpopuli" class="u-url mention" rel="nofollow noopener noreferrer" target="_blank">@nullvoxpopuli</a> <a href="https://fosstodon.org/tags/qunit" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#qunit</a> <a href="https://fosstodon.org/tags/WriteTheDocs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#WriteTheDocs</a> <a href="https://fosstodon.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalWriting</a> <a href="https://fosstodon.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#SoftwareDocumentation</a> <a href="https://fosstodon.org/tags/documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#documentation</a> <a href="https://fosstodon.org/tags/TDD" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TDD</a>

Miguel Afonso Caetano"Most guides to docs like code, even the ones for non-devs, assume you have some developer knowledge: maybe you're already using version control, or you've encountered build pipelines before, or you're working alongside developers.This guide is for the people who read that paragraph and wished it came with a glossary. This is docs like code for people who don't know what git is and have never installed VS Code.This post explains terminology and concepts, to help you get a mental model of what's going on. If you prefer to dive in and pick up concepts as you go, skip straight to the tips in How to learn, and come back to the conceptual info as needed."<a href="https://deborahwrites.com/blog/docs-like-code-basic-intro/" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://deborahwrites.com/blog/docs-like-code-basic-intro/</a> <a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalWriting</a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#SoftwareDocumentation</a> <a href="https://tldr.nettime.org/tags/SoftwareDevelopment" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#SoftwareDevelopment</a> <a href="https://tldr.nettime.org/tags/Programming" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Programming</a> <a href="https://tldr.nettime.org/tags/DocsAsCode" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#DocsAsCode</a> <a href="https://tldr.nettime.org/tags/Git" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Git</a> <a href="https://tldr.nettime.org/tags/Markdown" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Markdown</a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalCommunication</a> <a href="https://tldr.nettime.org/tags/MkDocs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#MkDocs</a> <a href="https://tldr.nettime.org/tags/VSCode" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#VSCode</a>

Miguel Afonso Caetano"When evaluating documentation’s role, consider these broader strategic questions:- Strategic positioning: How does documentation support the company’s core strategic approach?- Competitive advantage: Can documentation create or enhance the company’s unique market position? What type of documentation does the competition offer?- Value proposition: How does documentation contribute to the product’s overall value for customers?- Knowledge management: How does documentation support internal knowledge retention and transfer?- Customer lifecycle: How can documentation improve customer acquisition, retention, and satisfaction?"<a href="https://www.thegooddocsproject.dev/blog/making-business-base-know-company-goals" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://www.thegooddocsproject.dev/blog/making-business-base-know-company-goals</a><a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalWriting</a> <a href="https://tldr.nettime.org/tags/Documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Documentation</a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#SoftwareDocumentation</a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalCommunication</a>

Alistair KA weird parliamentary repeal bill complaining that the Plain Language Act costs too much to implement. I am concerned that Judith Collins, Key's old whipping dummy, wants both to excuse poor writers (contrary to the back-to-basics literacy drive in schools) and also to legalise obfuscation as an exclusionary measure. <a href="https://bills.parliament.nz/v/6/056F85E8-A3B3-4124-7DA9-08DD6A63478A?Tab=history?Tab=history" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://bills.parliament.nz/v/6/056F85E8-A3B3-4124-7DA9-08DD6A63478A?Tab=history?Tab=history</a><a href="https://mastodon.nz/tags/technicalwriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#technicalwriting</a> <a href="https://mastodon.nz/tags/writing" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#writing</a> <a href="https://mastodon.nz/tags/nzpol" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#nzpol</a>

Third spruce tree on the leftEverytime I have to write "Yeah, about this button. it doesn't do anything. Don't click it. The developers didn't finish that feature in time but were too lazy to hide it before we shipped" I die a little bit inside. <a href="https://mas.to/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalWriting</a> <a href="https://mas.to/tags/documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#documentation</a>

Dewey Ritten (taylor's version) :donor:Looking for advice, resources, and textbook recommendations on technical & professional writing.I'm tutoring someone with extensive software development expertise who's now looking to improve her technical writing skills. She's also dyslexic, and any resources specific to strategies and pedagogies for adult learners with dyslexia would be appreciated.It's been a long while since I've taught composition, and I was hoping the <a href="https://infosec.exchange/tags/rhetcomp" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#rhetcomp</a> community would have some suggestions. I appreciate your help!Please feel free to tag anyone who you'd think I could benefit from following, too.<a href="https://infosec.exchange/tags/rhetoricandcomposition" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#rhetoricandcomposition</a> <a href="https://infosec.exchange/tags/writingcommunity" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#writingcommunity</a> <a href="https://infosec.exchange/tags/writing" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#writing</a> <a href="https://infosec.exchange/tags/writingpedagogy" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#writingpedagogy</a> <a href="https://infosec.exchange/tags/composition" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#composition</a> <a href="https://infosec.exchange/tags/teaching" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#teaching</a> <a href="https://infosec.exchange/tags/writinginstructor" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#writinginstructor</a> <a href="https://infosec.exchange/tags/highered" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#highered</a> <a href="https://infosec.exchange/tags/technicalwriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#technicalwriting</a>

Miguel Afonso Caetano"You can replace tech writers with an LLM, perhaps supervised by engineers, and watch the world burn. Nothing prevents you from doing that. All the temporary gains in efficiency and speed would bring something far worse on their back: the loss of the understanding that turns knowledge into a conversation. Tech writers are interpreters who understand the tech and the humans trying to use it. They’re accountable for their work in ways that machines can’t be.The future of technical documentation isn’t replacing humans with AI but giving human writers AI-powered tools that augment their capabilities. Let LLMs deal with the tedious work at the margins and keep the humans where they matter most: at the helm of strategy, tending to the architecture, bringing the empathy that turns information into understanding. In the end, docs aren’t just about facts: they’re about trust. And trust is still something only humans can build."<a href="https://passo.uno/whats-wrong-ai-generated-docs/" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://passo.uno/whats-wrong-ai-generated-docs/</a><a href="https://tldr.nettime.org/tags/AI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#AI</a> <a href="https://tldr.nettime.org/tags/GenerativeAI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#GenerativeAI</a> <a href="https://tldr.nettime.org/tags/LLMs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#LLMs</a> <a href="https://tldr.nettime.org/tags/Chatbots" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Chatbots</a> <a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalWriting</a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalCommunication</a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#SoftwareDocumentation</a> <a href="https://tldr.nettime.org/tags/SoftwareDevelopment" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#SoftwareDevelopment</a> <a href="https://tldr.nettime.org/tags/TechnicalDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalDocumentation</a> <a href="https://tldr.nettime.org/tags/Docs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Docs</a>

DJ AdamsPassionate and well written, recommended Sunday reading "What's wrong with AI-generated docs" <a href="https://passo.uno/whats-wrong-ai-generated-docs/" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://passo.uno/whats-wrong-ai-generated-docs/</a> via @wallabagapp<a href="https://hachyderm.io/tags/AI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#AI</a> <a href="https://hachyderm.io/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalWriting</a>

jmacI wrote up a tech-writing technique I call the assertions document. It helps you rapidly develop your own understanding of a new-to-you topic by getting your subject-matter experts engaged in the docs project as quickly as possible, and even eager to help you—largely by giving them ways to tell you how you're wrong. <a href="https://masto.nyc/tags/TechWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechWriting</a> <a href="https://masto.nyc/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalWriting</a> <a href="https://fogknife.com/2025-04-04-assert-your-way-to-stronger-technical-writing.html" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://fogknife.com/2025-04-04-assert-your-way-to-stronger-technical-writing.html</a>

jmacHere's one for the tech writers, writing about tech writing: <a href="https://masto.nyc/tags/TechWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechWriting</a> <a href="https://masto.nyc/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalWriting</a>

Miguel Afonso Caetano"The following are my suggestions regarding what else to consider for each of Daryl White’s excellent questions about choosing a toolset for documenting a software product or project.I have appended a brief guide to the main/broad categories of documentation toolsets and some of the platforms/components that are popular in each.Finally, this resource ends with a table of possible solutions for various scenarios you might find yourself in.Before we start with the existing list of questions, I want to highlight one that I think is most important of all, but which is often assumed by people who create these kinds of guides, as they tend to come from one or another world already.What are you documenting?When it comes to software technical writing, the more appropriate way to ask this might be: For what user roles is your documentation intended?For graphical end-user interfaces (GUIs), the largest range of docs tooling is available, but here some of the more commercial turnkey tools have most of their advantages.For administrator interfaces (installation, configuration, etc), again any tooling will work, but we start seeing real advantages for lightweight markup, codebase integration, and version control.For developer interfaces, docs-as-code offers significant advantages. Developers can better contribute directly, and it’s generally friendlier for coded samples. APIs (native and remote), SDKs, and CLIs are almost certainly best documented in a docs-as-code environment, even if you integrate it with a more conventional platform for end-user docs."<a href="https://gist.github.com/briandominick/d4cbe11228de0ebe31cda630976af4ef" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://gist.github.com/briandominick/d4cbe11228de0ebe31cda630976af4ef</a><a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalWriting</a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#SoftwareDocumentation</a> <a href="https://tldr.nettime.org/tags/Documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Documentation</a> <a href="https://tldr.nettime.org/tags/DocsAsCode" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#DocsAsCode</a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalCommunication</a> <a href="https://tldr.nettime.org/tags/InformationArchitecture" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#InformationArchitecture</a> <a href="https://tldr.nettime.org/tags/CCMS" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#CCMS</a>

Miguel Afonso Caetano"The accompanying diagram is intended to help you quickly decide how to document an API, but particularly a REST API. The first split is just to make sure you are looking for the right kind of API.Here is some more context to help you decide on an approach and get started."<a href="https://gist.github.com/briandominick/3ffab6be460fbde799aa34e0a42a4299" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://gist.github.com/briandominick/3ffab6be460fbde799aa34e0a42a4299</a><a href="https://tldr.nettime.org/tags/API" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#API</a> <a href="https://tldr.nettime.org/tags/APIs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#APIs</a> <a href="https://tldr.nettime.org/tags/APIDesign" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#APIDesign</a> <a href="https://tldr.nettime.org/tags/REST" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#REST</a> <a href="https://tldr.nettime.org/tags/APIDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#APIDocumentation</a> <a href="https://tldr.nettime.org/tags/OpenAPI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#OpenAPI</a> <a href="https://tldr.nettime.org/tags/DocsAsCode" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#DocsAsCode</a> <a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalWriting</a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalCommunication</a>

Miguel Afonso Caetano"No one’s heard of a starving craftsman, just starving artists, and for a reason. Craftsmen create something people need. You’ve mastered a few important skills and moved up in the company. The important aspect here is that as you reach out to a greater community, you realize that there are plenty of people who are more skilled than you and who are still learning. Learn from them.Gaining textbook skills or collecting certifications isn’t the point anymore; it’s applying all this knowledge in practical ways. Along the journey, you need to watch out for your best career interests and make sure that what you’re doing is what you want to do. For example, many get lost in promotions that lure them away from what they like doing, whether that’s programming or writing.Finally, don’t underestimate perpetual learning. This is the key to the long road. Take time to practice, even if your job doesn’t seem to allow it. Learn new skills or apply existing skills in new ways. Along with practice comes failure, but don’t let that discourage you."<a href="https://robertdelwood.medium.com/book-review-apprenticeship-patterns-guidance-for-the-aspiring-software-craftsman-808c95ee478e" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://robertdelwood.medium.com/book-review-apprenticeship-patterns-guidance-for-the-aspiring-software-craftsman-808c95ee478e</a><a href="https://tldr.nettime.org/tags/Craftsmanship" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Craftsmanship</a> <a href="https://tldr.nettime.org/tags/Craftsman" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Craftsman</a> <a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalWriting</a> <a href="https://tldr.nettime.org/tags/SoftwareDevelopment" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#SoftwareDevelopment</a> <a href="https://tldr.nettime.org/tags/Programming" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Programming</a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalCommunication</a>

DacharyWhen we started talking about performing a code example audit, I wondered if we could use an LLM to help us categorize our code examples. I built a quick PoC on a Friday, and we ended up iterating on it to perform the audit.Spoiler alert: LLM categorization accuracy plunged from 90% to 36.7% using real-world data.This is part four in an eight-part series about auditing the code examples in our documentation.<a href="https://dacharycarey.com/2025/03/23/audit-ai-assisted-classification/" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://dacharycarey.com/2025/03/23/audit-ai-assisted-classification/</a><a href="https://dacharycarey.social/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalWriting</a> <a href="https://dacharycarey.social/tags/Documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Documentation</a> <a href="https://dacharycarey.social/tags/DeveloperDocs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#DeveloperDocs</a>

RS, Author, Novelist, Prosaist<a href="https://wetdry.world/@eblu" class="u-url mention" rel="nofollow noopener noreferrer" target="_blank">@eblu</a> <blockquote>[scanned cartoon caption reads:] EVEN WHEN THEY'RE TRYING TO COMPENSATE FOR IT, EXPERTS IN ANYTHING WILDLY OVERESTIMATE THE AVERAGE PERSON'S FAMILIARITY WITH THEIR FIELD</blockquote>I wrote technical manuals a while. Those who write the software are incapable of explaining it to a novice. Indeed, once the writer understands the software, quality goes down, not up as they edit toward concision. This is where training, self-awareness, and outside readers make a difference.<a href="https://eldritch.cafe/tags/Software" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Software</a> <a href="https://eldritch.cafe/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalWriting</a> <a href="https://eldritch.cafe/tags/Writer" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Writer</a> <a href="https://eldritch.cafe/tags/Author" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Author</a> <a href="https://eldritch.cafe/tags/WritersOfMastodon" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#WritersOfMastodon</a> <a href="https://eldritch.cafe/tags/WritingCommunity" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#WritingCommunity</a> <a href="https://eldritch.cafe/tags/Programming" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Programming</a>

Miguel Afonso Caetano"[E]ven thinking about the right approach for documentation, apart from the documentation artifact I end up producing, is a form of thinking. And this is my larger point, more than the specific logic of my actual argument. Deciding on the approach is a form of thinking that technical writers engage in. Even when we use AI tools to streamline documentation, it doesn’t mean we’re removing ourselves from thinking and reflection. As long as we’re still engaging somewhere, I think Warner would approve. In this way, we use AI tools to augment and amplify the scope of our thinking, not reduce it."<a href="https://tldr.nettime.org/tags/AI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#AI</a> <a href="https://tldr.nettime.org/tags/GenerativeAI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#GenerativeAI</a> <a href="https://tldr.nettime.org/tags/Writing" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Writing</a> <a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalWriting</a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#SoftwareDocumentation</a> <a href="https://tldr.nettime.org/tags/TechnicalDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalDocumentation</a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalCommunication</a> <a href="https://idratherbewriting.com/blog/jonathan-warner-more-than-words-book-review" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://idratherbewriting.com/blog/jonathan-warner-more-than-words-book-review</a>

Juhis"How do you deal with code snippets in blog posts getting outdated?"Every time I give a talk about blogging for developers, I'm asked this. Now I started to take action with the first iteration of the solution.I added version metadata to my blog posts and display them at the start of the post.<a href="https://hamatti.org/posts/track-software-versions-for-technical-blog-posts/" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://hamatti.org/posts/track-software-versions-for-technical-blog-posts/</a><a href="https://mastodon.world/tags/blogging" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#blogging</a> <a href="https://mastodon.world/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalWriting</a>

Phil DavisI'm wrapping up a project, strategic & self-paced. It's been rewarding, but the finish-line push is killing me. I need to submit it. I can take it only so far on my own. Still, it's so big that I'm always finding something to fix. Dang it, today is the day.<a href="https://mastodon.nz/tags/technicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#technicalWriting</a> <a href="https://mastodon.nz/tags/techWriterLife" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#techWriterLife</a>

DacharyWhen we built tooling to audit the code examples in our documentation, we had to decide how to access the data. We had a rough idea of what content we wanted to audit, but implementation required more than a rough idea. We also had to decide how to work with this content and what to do with the resulting data.This is part three in an eight-part series about auditing the code examples in our documentation.<a href="https://dacharycarey.com/2025/03/16/audit-access-data/" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://dacharycarey.com/2025/03/16/audit-access-data/</a><a href="https://dacharycarey.social/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalWriting</a> <a href="https://dacharycarey.social/tags/Documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Documentation</a> <a href="https://dacharycarey.social/tags/DeveloperDocs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#DeveloperDocs</a>

Recent searches

Search options

Administered by:

Server stats:

#technicalwriting