Dysmorphia💛🤍💜🖤<p>I’m doing the Instant Pot test run following the user manual. The user manual is very good—I mean speaking as a professional it’s excellent technical writing. I would use this manual to teach a class in how to do it right. <a href="https://sfba.social/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalWriting</span></a> <br> <a href="https://sfba.social/tags/cooking" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>cooking</span></a> <a href="https://sfba.social/tags/food" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>food</span></a></p>
Recent searches
No recent searches
Search options
Only available when logged in.
eupolicy.social is one of the many independent Mastodon servers you can use to participate in the fediverse.
This Mastodon server is a friendly and respectful discussion space for people working in areas related to EU policy. When you request to create an account, please tell us something about you.
Administered by:
Server stats:
225active users
eupolicy.social: About · Profiles directory · Privacy policy
Mastodon: About · Get the app · Keyboard shortcuts · View source code · v4.3.8
#technicalwriting
0 posts · 0 participants · 0 posts today
Miguel Afonso Caetano<p>"The purpose of documentation is to skill and empower someone in their craft. It serves their acquisition and application of skill.</p><p>I have heard it suggested that documentation should now be optimised for consumption by AI. That is like asking how we can make our cities better for cars, or our workplaces better for the furniture.</p><p>If creators of documentation are prepared to sacrifice its human purpose in order that LLMs can more effectively slurp it up and regurgitate it on demand, then they have meekly accepted values that more properly belong in a dystopian horror story.</p><p>Even if we think about the notion only pragmatically, leaving all values aside, it’s a panicky, inconsidered idea. What possible sense does it make to try to “write for LLMs” when LLMs themselves are evolving so rapidly that their capacities and patterns change from one week to the next?</p><p>Human beings are difficult creatures with complex needs, but they have been that kind of creature for thousands of years. Not only have we painstakingly built up deep understanding of them, we are them; we can know them from the inside. A good way of writing documentation for human beings today will still be a good way to do it in a few years’ time."</p><p><a href="https://vurt.org/articles/my-favourite-german-word/" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">vurt.org/articles/my-favourite</span><span class="invisible">-german-word/</span></a></p><p><a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalWriting</span></a> <a href="https://tldr.nettime.org/tags/AI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>AI</span></a> <a href="https://tldr.nettime.org/tags/GenerativeAI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>GenerativeAI</span></a> <a href="https://tldr.nettime.org/tags/LLMs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>LLMs</span></a> <a href="https://tldr.nettime.org/tags/Chatbots" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Chatbots</span></a> <a href="https://tldr.nettime.org/tags/Documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Documentation</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDocumentation</span></a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalCommunication</span></a></p>
Miguel Afonso Caetano<p>“The goal from starting out is to be able to create an API documentation suite from scratch. The minimal viable document, or the minimum the document must contain before it’s released, includes having all the calls covered, a description, even if only one sentence at this point, for every field and call, section overviews, call examples, and examples of each field. I suggest also creating a Postman collection file for each API suite. A Postman collection file is a complete set of all the requests and that each request may be run by clicking it; it’s a convenience to clients.</p><p>Being able to create that document indicates the writer’s proficiency in the mechanics of API documentation. There is a sense of accomplishment when achieving this and comfort with this process. And rightly so. They have the privilege now of calling themselves API documentation writers.”</p><p><a href="https://robertdelwood.medium.com/starting-api-documentation-writers-obstacles-to-watch-out-for-e0907610466f" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">robertdelwood.medium.com/start</span><span class="invisible">ing-api-documentation-writers-obstacles-to-watch-out-for-e0907610466f</span></a></p><p><a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalWriting</span></a> <a href="https://tldr.nettime.org/tags/APIDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>APIDocumentation</span></a> <a href="https://tldr.nettime.org/tags/APIs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>APIs</span></a> <a href="https://tldr.nettime.org/tags/Programming" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Programming</span></a> <a href="https://tldr.nettime.org/tags/OpenAPI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>OpenAPI</span></a> <a href="https://tldr.nettime.org/tags/DocsAsCode" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>DocsAsCode</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDevelopment" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDevelopment</span></a> <a href="https://tldr.nettime.org/tags/Postman" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Postman</span></a></p>
Miguel Afonso Caetano<p>"What are docs for AI agents? How are they different than internal eng docs? Do we really have to maintain the agent docs and eng docs as separate docs sets? This page contains my notes on these questions.</p><p>Scope:</p><p>I work on developer docs i.e. docs for software engineers. I don’t know how relevant AI agents are for technical writers in other industries or domains.</p><p>I’m thinking specifically about docs for AI agents. I’m not sure that an all-encompassing “docs for AI best practices” exists. The way that we optimize docs for RAG-based chatbots (for example) is probably different than the way we optimize docs for AI agents."</p><p><a href="https://technicalwriting.dev/ai/agents/" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">technicalwriting.dev/ai/agents</span><span class="invisible">/</span></a></p><p><a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalWriting</span></a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalCommunication</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDocumentation</span></a> <a href="https://tldr.nettime.org/tags/AI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>AI</span></a> <a href="https://tldr.nettime.org/tags/GenerativeAI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>GenerativeAI</span></a> <a href="https://tldr.nettime.org/tags/AIAgents" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>AIAgents</span></a> <a href="https://tldr.nettime.org/tags/DocsForAIAgents" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>DocsForAIAgents</span></a> <a href="https://tldr.nettime.org/tags/Chatbots" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Chatbots</span></a> <a href="https://tldr.nettime.org/tags/DeveloperDocs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>DeveloperDocs</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDevelopment" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDevelopment</span></a></p>
Miguel Afonso Caetano<p>"Among the many forms of yak shaving that plague our craft is obsessing over documentation tooling. The more technically minded among us are guilty of spending too much time tightening the screws of some CI pipeline just to save a few seconds when building the docs. As exercises, they’re indeed useful, for they help us practice technical skills that might lead us to becoming docs engineers. Should we park writing the docs over picking static-site generators though?</p><p>The danger lies in mistaking the motion for progress. A perfectly tuned pipeline that builds no new useful content is a monument to wasted effort. It’s the equivalent of a chef who spends all day sharpening their knives to a razor’s edge but never actually cooks a meal. The knives are essential, but they are not the dinner. Our tools are essential, but they are not the documentation. The user who is stuck at 2 AM with a failing API call does not care about your elegant build process; they care about finding the answer."</p><p><a href="https://passo.uno/things-tech-writers-shouldnt-care-about/" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">passo.uno/things-tech-writers-</span><span class="invisible">shouldnt-care-about/</span></a></p><p><a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalWriting</span></a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalCommunication</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDocumentation</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDevelopment" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDevelopment</span></a> <a href="https://tldr.nettime.org/tags/Docs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Docs</span></a> <a href="https://tldr.nettime.org/tags/Documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Documentation</span></a></p>
Strfnurfn<p>EDIT: Thanks all!! I'm passing along your suggestions. </p><p>Anyone know an open-source project, even a small one, that needs API docs created or improved? Asking for a <a href="https://mstdn.social/tags/technicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>technicalWriting</span></a> pro who wants more experience with API documentation. <a href="https://mstdn.social/tags/FOSS" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>FOSS</span></a> <a href="https://mstdn.social/tags/techcomm" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>techcomm</span></a> (bonus points if it hits interests like politics, food, beer, auto racing, mapping/OSM, civil engineering, social good...)</p>
Miguel Afonso Caetano<p>"Our biggest challenge as technical writers is bridging the gap between the tech we document and the users trying to understand it. LLMs provide us with the support we need to build that bridge. But it’s more than just a bridge to the user; it’s a mirror for the self. Running a draft through an LLM allows me to remix, rewrite, and truly understand what I’m trying to say. I’m not mindlessly generating with AI; I’m thinking through AI. It’s the writer’s equivalent to rubber duck debugging.</p><p>The tools we build using LLMs also allow our words to materialize as direct product impact and socialize our thoughts inside organizations. Think of the typical debates over a confusing user interface. Before, I used to argue based on my own expertise and intuition. Today, I could say, “I ran our docs through Impersonaid and it got stuck at this exact step. Here’s the full transcript.” Suddenly, my argument becomes a reproducible linguistic experiment"</p><p><a href="https://tldr.nettime.org/tags/AI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>AI</span></a> <a href="https://tldr.nettime.org/tags/GenerativeAI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>GenerativeAI</span></a> <a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalWriting</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDocumentation</span></a> <a href="https://tldr.nettime.org/tags/UserPersonas" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>UserPersonas</span></a> <a href="https://tldr.nettime.org/tags/LLMs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>LLMs</span></a> <a href="https://tldr.nettime.org/tags/Chatbots" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Chatbots</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDevelopment" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDevelopment</span></a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalCommunication</span></a> </p><p><a href="https://passo.uno/thinking-better-through-ai/" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">passo.uno/thinking-better-thro</span><span class="invisible">ugh-ai/</span></a></p>
Miguel Afonso Caetano<p>"How to leverage documentation effectively in Cursor through prompting, external sources, and internal context<br><br>Why documentation matters</p><p>Documentation provides current, accurate context. Without it, models use outdated or incomplete training data. Documentation helps models understand things like:</p><p>- Current APIs and parameters<br>- Best practices<br>- Organization conventions<br>- Domain terminology</p><p>And much more. Read on to learn how to use documentation right in Cursor without having to context switch."</p><p><a href="https://docs.cursor.com/guides/advanced/working-with-documentation" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">docs.cursor.com/guides/advance</span><span class="invisible">d/working-with-documentation</span></a></p><p><a href="https://tldr.nettime.org/tags/AI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>AI</span></a> <a href="https://tldr.nettime.org/tags/GenerativeAI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>GenerativeAI</span></a> <a href="https://tldr.nettime.org/tags/Cursor" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Cursor</span></a> <a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalWriting</span></a> <a href="https://tldr.nettime.org/tags/Documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Documentation</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDevelopment" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDevelopment</span></a> <a href="https://tldr.nettime.org/tags/APIDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>APIDocumentation</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDocumentation</span></a></p>
Dysmorphia💛🤍💜🖤<p>Haunted manuals lightning talk</p><p>I gave a lightning <a href="https://sfba.social/tags/WriteTheDocs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>WriteTheDocs</span></a> in Portland, and in this post I share the recording and my slide deck.</p><p><a href="https://rinsemiddlebliss.com/posts/2025-05-16-haunted-manuals/" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">rinsemiddlebliss.com/posts/202</span><span class="invisible">5-05-16-haunted-manuals/</span></a></p><p><a href="https://sfba.social/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalWriting</span></a></p>
Anthony Dean<p>I've tried getting writing related work (specifically technical writing) for years and it's ultimately not exactly been as successful as I'd like. (One reason I run my blog, as a writing outlet/show my skills.) Reading about writers getting hired while using AI isn't encouraging.</p><p><a href="https://mastodon.social/tags/writing" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>writing</span></a> <a href="https://mastodon.social/tags/technicalwriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>technicalwriting</span></a></p>
Miguel Afonso Caetano<p>"Your voice must be heard. Inside of your work, you need key stakeholders and teams to know what it is that you do and the value you bring to product development. Your docs are vital infrastructure, but folks won’t realize that until it’s too late. Unless, of course, you become an ambassador of your craft and start making yourself heard and present everywhere. One of the first things I did when I joined a startup was sending an email to the team telling them what I did. It became my first post.</p><p>Outside of work, this task is equally important, because tech writing has a depth issue. You must develop a sense of pride in technical communication as a vital discipline. Don’t shy away from intellectual engagement and contribute to the field by sharing your own thoughts, theories, and errors. Some career ladders label that as “thought leadership”. It’s really about showing up and owning the conversation around what we do and why it matters, moving beyond praxis to noesis."</p><p><a href="https://passo.uno/how-to-grow-senior-tech-writer/" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">passo.uno/how-to-grow-senior-t</span><span class="invisible">ech-writer/</span></a></p><p><a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalWriting</span></a> <a href="https://tldr.nettime.org/tags/TechnicalWriter" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalWriter</span></a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalCommunication</span></a> <a href="https://tldr.nettime.org/tags/LifeLongLearning" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>LifeLongLearning</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDocumentation</span></a> <a href="https://tldr.nettime.org/tags/DocsAsInfrastructure" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>DocsAsInfrastructure</span></a></p>
Miguel Afonso Caetano<p>"Welcome to the State of Docs Report 2025, bringing together insights from documentation experts from across the industry.</p><p>This comprehensive report explores how teams track their docs’ success, the future of the industry, the ongoing impact of AI on documentation, and much more.<br>(...)<br>We received responses from 444 hands-on documentation experts — including technical writers, managers, engineers, support teams, designers, marketers, and developer advocates. This variety shows just how many teams are involved and invested in documentation today.</p><p>We also conducted interviews with a number of technical writers, engineers, and documentation leaders from across the tech industry to get their insights into specific areas — you can read quotes from them throughout the report.</p><p>TAKEAWAYS:</p><p>- 54% believe their docs generate at least as many leads as their marketing sites</p><p>- 42% think AI will let us build docs that intelligently adapt to user needs</p><p>- 46% of large companies have decentralized or hybrid docs teams"</p><p><a href="https://www.stateofdocs.com/2025/" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://www.</span><span class="">stateofdocs.com/2025/</span><span class="invisible"></span></a></p><p><a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalWriting</span></a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalCommunication</span></a> <a href="https://tldr.nettime.org/tags/Documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Documentation</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDocumentation</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDevelopment" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDevelopment</span></a> <a href="https://tldr.nettime.org/tags/AI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>AI</span></a> <a href="https://tldr.nettime.org/tags/Marketing" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Marketing</span></a></p>
Dachary<p>Back on the topic of auditing code examples in our documentation, part 5 of my 8-part series dives deep into the data model we used to store metadata and the code examples.</p><p>I look at the types of queries this model enables, performance implications, and future iteration. Data modeling is one of my favorite exercises, and I'm happy with the outcome for this project!</p><p><a href="https://dacharycarey.social/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalWriting</span></a> <a href="https://dacharycarey.social/tags/DeveloperDocs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>DeveloperDocs</span></a></p><p><a href="https://dacharycarey.com/2025/04/27/audit-model-code-example-metadata/" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">dacharycarey.com/2025/04/27/au</span><span class="invisible">dit-model-code-example-metadata/</span></a></p>
Miguel Afonso Caetano<p>“When I say that tech writers should own the prompt that generates documentation, I mean two things: that they should design and maintain the prompts, and that they should spearhead docs automation initiatives themselves, as I suggested in my tech writing predictions for 2025. It’s not just about using LLMs at work or tolerating their existence: writers must lead the way and own the conversations with AIs around docs.</p><p>What Aikidocs aims at showing is that you can work with an LLM as you would with a tech savvy intern: you provide a style guide, concrete guidance, and source materials to get acceptable output on the other side of the black box. All the content created in those carefully fenced pens will follow your content strategy more than if you let opinionated tools do it for you.</p><p>It’s not vibe coding: it’s LLM surfing.”</p><p><a href="https://passo.uno/build-tech-writing-tools-llms/" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">passo.uno/build-tech-writing-t</span><span class="invisible">ools-llms/</span></a></p><p><a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalWriting</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDocumentation</span></a> <a href="https://tldr.nettime.org/tags/AI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>AI</span></a> <a href="https://tldr.nettime.org/tags/GenerativeAI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>GenerativeAI</span></a> <a href="https://tldr.nettime.org/tags/LLMs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>LLMs</span></a></p>
QUnit<p>Ever wondered how beforeEach works in unit test frameworks? Check out our new lifecycle diagram!</p><p><a href="https://qunitjs.com/lifecycle/" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="">qunitjs.com/lifecycle/</span><span class="invisible"></span></a></p><p>People generally guess right when it comes to ordering, so why a diagram?</p><p>We want to show that the order is guaranteed, and showcase what's possible when you depend on it.</p><p>Thanks to FND, Jan, and NullVoxPopuli for improving and promoting this work! H/T <span class="h-card" translate="no"><a href="https://hachyderm.io/@FND" class="u-url mention" rel="nofollow noopener noreferrer" target="_blank">@<span>FND</span></a></span> <span class="h-card" translate="no"><a href="https://hci.social/@simulo" class="u-url mention" rel="nofollow noopener noreferrer" target="_blank">@<span>simulo</span></a></span> <span class="h-card" translate="no"><a href="https://mastodon.coffee/@nullvoxpopuli" class="u-url mention" rel="nofollow noopener noreferrer" target="_blank">@<span>nullvoxpopuli</span></a></span> </p><p><a href="https://fosstodon.org/tags/qunit" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>qunit</span></a> <a href="https://fosstodon.org/tags/WriteTheDocs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>WriteTheDocs</span></a> <a href="https://fosstodon.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalWriting</span></a> <a href="https://fosstodon.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDocumentation</span></a> <a href="https://fosstodon.org/tags/documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>documentation</span></a> <a href="https://fosstodon.org/tags/TDD" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TDD</span></a></p>
Miguel Afonso Caetano<p>"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.</p><p>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.</p><p>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."</p><p><a href="https://deborahwrites.com/blog/docs-like-code-basic-intro/" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">deborahwrites.com/blog/docs-li</span><span class="invisible">ke-code-basic-intro/</span></a> </p><p><a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalWriting</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDocumentation</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDevelopment" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDevelopment</span></a> <a href="https://tldr.nettime.org/tags/Programming" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Programming</span></a> <a href="https://tldr.nettime.org/tags/DocsAsCode" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>DocsAsCode</span></a> <a href="https://tldr.nettime.org/tags/Git" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Git</span></a> <a href="https://tldr.nettime.org/tags/Markdown" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Markdown</span></a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalCommunication</span></a> <a href="https://tldr.nettime.org/tags/MkDocs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>MkDocs</span></a> <a href="https://tldr.nettime.org/tags/VSCode" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>VSCode</span></a></p>
Miguel Afonso Caetano<p>"When evaluating documentation’s role, consider these broader strategic questions:</p><p>- Strategic positioning: How does documentation support the company’s core strategic approach?</p><p>- Competitive advantage: Can documentation create or enhance the company’s unique market position? What type of documentation does the competition offer?</p><p>- Value proposition: How does documentation contribute to the product’s overall value for customers?</p><p>- Knowledge management: How does documentation support internal knowledge retention and transfer?</p><p>- Customer lifecycle: How can documentation improve customer acquisition, retention, and satisfaction?"</p><p><a href="https://www.thegooddocsproject.dev/blog/making-business-base-know-company-goals" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://www.</span><span class="ellipsis">thegooddocsproject.dev/blog/ma</span><span class="invisible">king-business-base-know-company-goals</span></a></p><p><a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalWriting</span></a> <a href="https://tldr.nettime.org/tags/Documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Documentation</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDocumentation</span></a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalCommunication</span></a></p>
Miguel Afonso Caetano<p>"When evaluating documentation’s role, consider these broader strategic questions:</p><p>- Strategic positioning: How does documentation support the company’s core strategic approach?</p><p>- Competitive advantage: Can documentation create or enhance the company’s unique market position? What type of documentation does the competition offer?</p><p>- Value proposition: How does documentation contribute to the product’s overall value for customers?</p><p>- Knowledge management: How does documentation support internal knowledge retention and transfer?</p><p>- Customer lifecycle: How can documentation improve customer acquisition, retention, and satisfaction?"</p><p><a href="https://www.thegooddocsproject.dev/blog/making-business-base-know-company-goals" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://www.</span><span class="ellipsis">thegooddocsproject.dev/blog/ma</span><span class="invisible">king-business-base-know-company-goals</span></a></p><p><a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalWriting</span></a> <a href="https://tldr.nettime.org/tags/Documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Documentation</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDocumentation</span></a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalCommunication</span></a></p>
Third spruce tree on the left<p>Everytime 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">#<span>TechnicalWriting</span></a> <a href="https://mas.to/tags/documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>documentation</span></a></p>
Miguel Afonso Caetano<p>"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.</p><p>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."</p><p><a href="https://passo.uno/whats-wrong-ai-generated-docs/" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">passo.uno/whats-wrong-ai-gener</span><span class="invisible">ated-docs/</span></a></p><p><a href="https://tldr.nettime.org/tags/AI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>AI</span></a> <a href="https://tldr.nettime.org/tags/GenerativeAI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>GenerativeAI</span></a> <a href="https://tldr.nettime.org/tags/LLMs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>LLMs</span></a> <a href="https://tldr.nettime.org/tags/Chatbots" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Chatbots</span></a> <a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalWriting</span></a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalCommunication</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDocumentation</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDevelopment" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDevelopment</span></a> <a href="https://tldr.nettime.org/tags/TechnicalDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalDocumentation</span></a> <a href="https://tldr.nettime.org/tags/Docs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Docs</span></a></p>
ExploreLive feeds
Mastodon is the best way to keep up with what's happening.
Follow anyone across the fediverse and see it all in chronological order. No algorithms, ads, or clickbait in sight.
Create accountLoginDrag & drop to upload