Dice.camp

Miguel Afonso Caetano"While haste and speed often get confused, they differ in that the second shows control instead of panic. You can maximize speed while keeping accuracy quite high; beyond a certain point, though, spending more time on accuracy, style, or other aspects that prevent a document from going live always yields diminishing returns.Nobody reads perfect yet outdated docs, except historians. Even then, docs aren’t perfect, because documentation can’t ever be perfect. This is a key principle I stand by (call it the Ferri Paradox if you want): Any document describing a system is necessarily inaccurate. And yet, this reality doesn’t significantly alter the impact of our work, because we aim for simplicity and usefulness over extreme faithfulness. Given how imperfect products are, docs are a charitable portrait.Now, how you write docs quickly depends on a number of factors. Some of those factors you can’t control: your overall amount of experience as a writer, your initial expertise with specific technologies, and the way features are developed and released in your organization. But other aspects are yours to act upon. For example, you can decide how to best use the technical resources at your disposal and how to approach writing the docs and asking for feedback."<a href="https://passo.uno/how-write-tech-docs-quickly/" rel="nofollow noopener" translate="no" target="_blank">https://passo.uno/how-write-tech-docs-quickly/</a><a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener" target="_blank">#TechnicalWriting</a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener" target="_blank">#TechnicalCommunication</a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#SoftwareDocumentation</a> <a href="https://tldr.nettime.org/tags/SoftwareDevelopment" class="mention hashtag" rel="nofollow noopener" target="_blank">#SoftwareDevelopment</a> <a href="https://tldr.nettime.org/tags/Programming" class="mention hashtag" rel="nofollow noopener" target="_blank">#Programming</a> <a href="https://tldr.nettime.org/tags/Docs" class="mention hashtag" rel="nofollow noopener" target="_blank">#Docs</a> <a href="https://tldr.nettime.org/tags/Documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#Documentation</a>

Miguel Afonso CaetanoBasic Questions That Every (Technical) Writer Should Try To Answer - AKA Technical Writing 101: I assure you that If you can answer all of these questions, your readers won't mistake you for a chatbot :)1. What is the purpose of the document that I'm writing?2. Why am I writing this document?3. Who is the target audience of this document?4. Is this document part of a series of documents?5. If so, have I established a nexus to the other documents in the series?6. Are there any predefined formal requirements that the document must meet?7. Does the document meet those requirements?8. Does the document include an introduction?9. Does the introduction clearly explain the purpose of the document to the target audience?10. Does the introduction present the topics that will be explored in the body of the document in a straightforward way?11. Does the document include a conclusion?12. Does the conclusion provide a good summary of the previously explored topics?13. Does the conclusion tell readers what they should have learned by following the document?14. Does the body of the document include use case scenarios based on user personas that explain the potential advantages of adopting the explored tools or methods?15. Does the body of the document depict real-life examples of how readers can immediately start using the tools or methods explained in the document?<a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener" target="_blank">#TechnicalWriting</a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener" target="_blank">#TechnicalCommunication</a> <a href="https://tldr.nettime.org/tags/Writing" class="mention hashtag" rel="nofollow noopener" target="_blank">#Writing</a> <a href="https://tldr.nettime.org/tags/Nonfiction" class="mention hashtag" rel="nofollow noopener" target="_blank">#Nonfiction</a> <a href="https://tldr.nettime.org/tags/Documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#Documentation</a> <a href="https://tldr.nettime.org/tags/Docs" class="mention hashtag" rel="nofollow noopener" target="_blank">#Docs</a>

Jan :rust: :ferris:Some people before 2022:Person A: "Nah, who needs documentation!? It's too much effort and not very useful."Person B: "But how should I understand this project then!? I'm totally lost right now!"Some people after 2022:Person X: "PR is ready for review. Please also have a look at the automated tests."Person A: "This needs rework: Please also update our cursor-rules, requirements.md and prompt.md file. Otherwise our <a href="https://floss.social/tags/LLM" class="mention hashtag" rel="nofollow noopener" target="_blank">#LLM</a> will be totally lost!"<a href="https://floss.social/tags/LLMs" class="mention hashtag" rel="nofollow noopener" target="_blank">#LLMs</a> <a href="https://floss.social/tags/AI" class="mention hashtag" rel="nofollow noopener" target="_blank">#AI</a> <a href="https://floss.social/tags/Documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#Documentation</a>

Franck ☠️[OT] PHPDocumentor vs Doxygen <a href="https://mstdn.nrkn.fr/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#documentation</a> <a href="https://mstdn.nrkn.fr/tags/d%C3%A9veloppement" class="mention hashtag" rel="nofollow noopener" target="_blank">#développement</a> <a href="https://mstdn.nrkn.fr/tags/PHP" class="mention hashtag" rel="nofollow noopener" target="_blank">#PHP</a> <a href="https://open-time.net/post/2025/07/20/PHPDocumentor-vs-Doxygen" rel="nofollow noopener" translate="no" target="_blank">https://open-time.net/post/2025/07/20/PHPDocumentor-vs-Doxygen</a>

Fake Scrum Stats Memes & Humor<a href="https://techhub.social/tags/scrum" class="mention hashtag" rel="nofollow noopener" target="_blank">#scrum</a> <a href="https://techhub.social/tags/scrumteam" class="mention hashtag" rel="nofollow noopener" target="_blank">#scrumteam</a> <a href="https://techhub.social/tags/dev" class="mention hashtag" rel="nofollow noopener" target="_blank">#dev</a> <a href="https://techhub.social/tags/developer" class="mention hashtag" rel="nofollow noopener" target="_blank">#developer</a> <a href="https://techhub.social/tags/qa" class="mention hashtag" rel="nofollow noopener" target="_blank">#qa</a> <a href="https://techhub.social/tags/scrummaster" class="mention hashtag" rel="nofollow noopener" target="_blank">#scrummaster</a> <a href="https://techhub.social/tags/productowner" class="mention hashtag" rel="nofollow noopener" target="_blank">#productowner</a> <a href="https://techhub.social/tags/leadership" class="mention hashtag" rel="nofollow noopener" target="_blank">#leadership</a> <a href="https://techhub.social/tags/management" class="mention hashtag" rel="nofollow noopener" target="_blank">#management</a> <a href="https://techhub.social/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#documentation</a> <a href="https://techhub.social/tags/NoDocumentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#NoDocumentation</a> <a href="https://techhub.social/tags/memes" class="mention hashtag" rel="nofollow noopener" target="_blank">#memes</a> <a href="https://techhub.social/tags/Meme" class="mention hashtag" rel="nofollow noopener" target="_blank">#Meme</a> <a href="https://techhub.social/tags/Humor" class="mention hashtag" rel="nofollow noopener" target="_blank">#Humor</a> <a href="https://techhub.social/tags/humour" class="mention hashtag" rel="nofollow noopener" target="_blank">#humour</a>

Frank‘He told us to just tell the truth’ – behind a revealing Billy Joel documentaryIn HBO’s five-hour portrait, the chart-dominating singer-songwriter gives unusual insight into his career with support from his A-list friends and collaborators<a href="https://www.theguardian.com/music/2025/jul/17/billy-joel-documentary-hbo" rel="nofollow noopener" translate="no" target="_blank">https://www.theguardian.com/music/2025/jul/17/billy-joel-documentary-hbo</a><a href="https://masto.nu/tags/News" class="mention hashtag" rel="nofollow noopener" target="_blank">#News</a> <a href="https://masto.nu/tags/Music" class="mention hashtag" rel="nofollow noopener" target="_blank">#Music</a> <a href="https://masto.nu/tags/BillyJoel" class="mention hashtag" rel="nofollow noopener" target="_blank">#BillyJoel</a> <a href="https://masto.nu/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#documentation</a> <a href="https://masto.nu/tags/AndSoItGoes" class="mention hashtag" rel="nofollow noopener" target="_blank">#AndSoItGoes</a> <a href="https://masto.nu/tags/Music" class="mention hashtag" rel="nofollow noopener" target="_blank">#Music</a>

Kevin Karhan :verified:And yes, whoever uses <a href="https://infosec.space/tags/discord" class="mention hashtag" rel="nofollow noopener" target="_blank">#discord</a> for <a href="https://infosec.space/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#documentation</a> and <a href="https://infosec.space/tags/versioning" class="mention hashtag" rel="nofollow noopener" target="_blank">#versioning</a> instead of a goddam <a href="https://infosec.space/tags/git" class="mention hashtag" rel="nofollow noopener" target="_blank">#git</a> [doesn't have to be <a href="https://infosec.exchange/@github" class="u-url mention" rel="nofollow noopener" target="_blank">@github</a> / <a href="https://infosec.space/tags/GitHub" class="mention hashtag" rel="nofollow noopener" target="_blank">#GitHub</a> or <a href="https://mastodon.social/@gitlab" class="u-url mention" rel="nofollow noopener" target="_blank">@gitlab</a> / <a href="https://infosec.space/tags/GitLab" class="mention hashtag" rel="nofollow noopener" target="_blank">#GitLab</a> or <a href="https://social.anoxinon.de/@Codeberg" class="u-url mention" rel="nofollow noopener" target="_blank">@Codeberg</a> / <a href="https://infosec.space/tags/Codeberg" class="mention hashtag" rel="nofollow noopener" target="_blank">#Codeberg</a> or even <a href="https://social.gitea.io/@gitea" class="u-url mention" rel="nofollow noopener" target="_blank">@gitea</a> / <a href="https://infosec.space/tags/Gitea" class="mention hashtag" rel="nofollow noopener" target="_blank">#Gitea</a> - just use any <code>git</code> and write down your documentation in a useable format like <a href="https://infosec.space/tags/Markdown" class="mention hashtag" rel="nofollow noopener" target="_blank">#Markdown</a> or goddamn ASCII plain text FFS] should be banned for life from <a href="https://infosec.space/tags/coding" class="mention hashtag" rel="nofollow noopener" target="_blank">#coding</a>, working in <a href="https://infosec.space/tags/IT" class="mention hashtag" rel="nofollow noopener" target="_blank">#IT</a> or contribute to <a href="https://infosec.space/tags/FLOSS" class="mention hashtag" rel="nofollow noopener" target="_blank">#FLOSS</a>. <ul><li>Because it's literally worse than people shitting "<a href="https://infosec.space/tags/Ai" class="mention hashtag" rel="nofollow noopener" target="_blank">#Ai</a>" <a href="https://infosec.space/tags/Slop" class="mention hashtag" rel="nofollow noopener" target="_blank">#Slop</a> all over the place cuz that can be fixed faster and easier by backrolling said commits and banning the offender! </li></ul><a href="https://www.youtube.com/watch?v=9ehLMlVTRJM&t=992" rel="nofollow noopener" translate="no" target="_blank">https://www.youtube.com/watch?v=9ehLMlVTRJM&t=992</a><a href="https://infosec.space/tags/AIslop" class="mention hashtag" rel="nofollow noopener" target="_blank">#AIslop</a> <a href="https://infosec.space/tags/Enshittification" class="mention hashtag" rel="nofollow noopener" target="_blank">#Enshittification</a>

Aneesh SatheDivine DocumentationDad was about my age when he said that reading the manual was better than hypothesis driven button pressing. For teenage me, that took too long. Sure, I may have crashed a computer or two but following my gut got me there. Of course my gut isn’t that smart. In the decades preceding, devices had converged on a common pattern language of buttons. Once learned, the standard grammar of action would reliably deliver me to my destination. <a href="https://aneeshsathe.com/wp-content/uploads/2025/07/image-from-rawpixel-id-441318-jpeg.jpg" rel="nofollow noopener" target="_blank"></a>Image of a nebula taken by the Hubble Telescope.In programming I was similarly aided by the shared patterns across MATLAB, Python, R, Java, Julia, and even HTML. In the end however, dad was right. Reading documentation is the way. Besides showing correct usage, manuals create a new understanding of my problems. I am able to play with tech thanks to the people that took the effort and the care to create good documentation. This is not limited to code and AI. During the startup years, great handbooks clarified accounting, fundraising, and regulations, areas foreign to me.I love good documentation and I write documentation. Writing good documentation is hard. It is an exercise in deep empathy with my user. Reaching into the future to give them all they need is part of creating good technology. Often the future user is me and I like it when past me is nice to now me. If an expert Socratic interlocutor is like weight training, documentation is a kindly spirit ancestor parting the mist. Maybe it’s something about being this age but now I try to impart good documentation practices to my teams. I also do not discourage pressing buttons to see what happens. Inefficient, but discovery is a fun way to spike interest.Meanwhile, I’m reading a more basic kind of documentation. Writing English. Having resolved to write more, I’m discovering that words are buttons. Poking them gets me to where I want, but not always. Despite writerly ambitions, the basics are lacking. This became apparent recently when I picked up the book Artful Sentences by Virginia Tufte*. It’s two hundred and seventy pages of wonderful sentences dissected to show their mechanics. I was lost by page 5. The book is, temporarily, in my anti-library. So, I’m going to the basics, Strunk and White, and William Zinsser. I’m hoping that Writing to Learn (finished) and On Writing Well (in progress) provide sufficient context about reasons to write to make the most of S&W, for the how, then somewhere down the road, savor Tufte. * Those dastardly Tuftes are always making me learn some kind of grammar.<a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/ai/" target="_blank">#AI</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/business/" target="_blank">#Business</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/continuouslearning/" target="_blank">#ContinuousLearning</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/devlife/" target="_blank">#DevLife</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/documentation/" target="_blank">#Documentation</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/empathyindesign/" target="_blank">#EmpathyInDesign</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/knowledgesharing/" target="_blank">#KnowledgeSharing</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/leadership/" target="_blank">#Leadership</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/learninginpublic/" target="_blank">#LearningInPublic</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/manualsmatter/" target="_blank">#ManualsMatter</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/opensource/" target="_blank">#OpenSource</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/philosophy/" target="_blank">#philosophy</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/programming/" target="_blank">#Programming</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/readthedocs/" target="_blank">#ReadTheDocs</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/science/" target="_blank">#science</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/softwaredevelopment/" target="_blank">#SoftwareDevelopment</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/startups/" target="_blank">#Startups</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/strunkandwhite/" target="_blank">#StrunkAndWhite</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/techwriting/" target="_blank">#TechWriting</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/virginiatufte/" target="_blank">#VirginiaTufte</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/williamzinsser/" target="_blank">#WilliamZinsser</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/writingwell/" target="_blank">#WritingWell</a>

DarylWait, you mean you're supposed to resolve the merge conflicts BEFORE publishing the docs?Huh.<a href="https://vmst.io/tags/git" class="mention hashtag" rel="nofollow noopener" target="_blank">#git</a> <a href="https://vmst.io/tags/wtd" class="mention hashtag" rel="nofollow noopener" target="_blank">#wtd</a> <a href="https://vmst.io/tags/writeTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#writeTheDocs</a> <a href="https://vmst.io/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#documentation</a>

DacharyA couple of cool things are landing this week.Our docs platform team is making a fix that unblocks my work to programmatically remove all the hard-coded code examples in our docs. I’m moving them out to individual files so we can more easily test/format/work with them.This also unblocks merging our first tested code examples into our larger docs corpus. We can merge our test suites for Node.js and Python code examples this week. 4 more test suites to go in our PoC 🎉<a href="https://dacharycarey.social/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#documentation</a>1/?

BookStackToday BookStack turns 10 years old! 🎂 In this blog-post we celebrate this decade of BookStack with a Q&A, while also diving into the stats & finances of the project:<a href="https://www.bookstackapp.com/blog/decade-of-bookstack/" rel="nofollow noopener" translate="no" target="_blank">https://www.bookstackapp.com/blog/decade-of-bookstack/</a><a href="https://fosstodon.org/tags/selfhosted" class="mention hashtag" rel="nofollow noopener" target="_blank">#selfhosted</a> <a href="https://fosstodon.org/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#documentation</a> <a href="https://fosstodon.org/tags/opensource" class="mention hashtag" rel="nofollow noopener" target="_blank">#opensource</a> <a href="https://fosstodon.org/tags/php" class="mention hashtag" rel="nofollow noopener" target="_blank">#php</a>

Godot.Berlin :godot:The alternative Godot docs viewer of our member <a href="https://mastodon.social/@rokojori" class="u-url mention" rel="nofollow noopener" target="_blank">@rokojori</a> has been updated to 4.4! 🎉 <a href="https://rokojori.com/en/labs/godot/docs/4.4/" rel="nofollow noopener" translate="no" target="_blank">https://rokojori.com/en/labs/godot/docs/4.4/</a>It also includes nodes of his very promising Rokojori Action Library (<a href="https://rokojori.com/en/labs/rokojori-action-library/overview" rel="nofollow noopener" translate="no" target="_blank">https://rokojori.com/en/labs/rokojori-action-library/overview</a>), but if you ignore those it is also a very nice alternative docs viewer for vanilla Godot!<a href="https://mastodon.gamedev.place/tags/GodotEngine" class="mention hashtag" rel="nofollow noopener" target="_blank">#GodotEngine</a> <a href="https://mastodon.gamedev.place/tags/Godot4" class="mention hashtag" rel="nofollow noopener" target="_blank">#Godot4</a> <a href="https://mastodon.gamedev.place/tags/Godot" class="mention hashtag" rel="nofollow noopener" target="_blank">#Godot</a> <a href="https://mastodon.gamedev.place/tags/OpenSource" class="mention hashtag" rel="nofollow noopener" target="_blank">#OpenSource</a> <a href="https://mastodon.gamedev.place/tags/GameDev" class="mention hashtag" rel="nofollow noopener" target="_blank">#GameDev</a> <a href="https://mastodon.gamedev.place/tags/Documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#Documentation</a> <a href="https://mastodon.gamedev.place/tags/Library" class="mention hashtag" rel="nofollow noopener" target="_blank">#Library</a>

Eddie.Love the feeling of updating documentation. Once a month I have a team meeting where we walk through technical IR tabletops. Today it was a brainstorming exercise on how to hunt behaviors and information over multiple tools, in case one goes down. And assuming I died. Work with my team to get creative and understand how tools work, especially with expertise missing. This is a good exercise for team robustness and education.And lets me take vacations mostly uninterrupted. Only 2x in 10 years, and both of those uninterrupted trips were in the last three years. Yee haw.<a href="https://infosec.exchange/tags/infosec" class="mention hashtag" rel="nofollow noopener" target="_blank">#infosec</a> <a href="https://infosec.exchange/tags/blueteam" class="mention hashtag" rel="nofollow noopener" target="_blank">#blueteam</a> <a href="https://infosec.exchange/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#documentation</a>

Vivekanandan KS :nixos:<a href="https://hachyderm.io/@thomasfuchs" class="u-url mention" rel="nofollow noopener" target="_blank">@thomasfuchs</a> Honestly I learnt every <a href="https://mstdn.social/tags/tech" class="mention hashtag" rel="nofollow noopener" target="_blank">#tech</a> skills of mine because of the <a href="https://mstdn.social/tags/passion" class="mention hashtag" rel="nofollow noopener" target="_blank">#passion</a>. Sooner or later we get these <a href="https://mstdn.social/tags/short" class="mention hashtag" rel="nofollow noopener" target="_blank">#short</a> <a href="https://mstdn.social/tags/term" class="mention hashtag" rel="nofollow noopener" target="_blank">#term</a> and <a href="https://mstdn.social/tags/long" class="mention hashtag" rel="nofollow noopener" target="_blank">#long</a> term <a href="https://mstdn.social/tags/purpose" class="mention hashtag" rel="nofollow noopener" target="_blank">#purpose</a>. But if someone's going for <a href="https://mstdn.social/tags/AI" class="mention hashtag" rel="nofollow noopener" target="_blank">#AI</a> <a href="https://mstdn.social/tags/coding" class="mention hashtag" rel="nofollow noopener" target="_blank">#coding</a> for the sake of <a href="https://mstdn.social/tags/Job" class="mention hashtag" rel="nofollow noopener" target="_blank">#Job</a> / <a href="https://mstdn.social/tags/Career" class="mention hashtag" rel="nofollow noopener" target="_blank">#Career</a> might not <a href="https://mstdn.social/tags/sustain" class="mention hashtag" rel="nofollow noopener" target="_blank">#sustain</a> if things get hard. That's why I <a href="https://mstdn.social/tags/suggest" class="mention hashtag" rel="nofollow noopener" target="_blank">#suggest</a> people to <a href="https://mstdn.social/tags/learn" class="mention hashtag" rel="nofollow noopener" target="_blank">#learn</a> <a href="https://mstdn.social/tags/organically" class="mention hashtag" rel="nofollow noopener" target="_blank">#organically</a> developing their mind <a href="https://mstdn.social/tags/map" class="mention hashtag" rel="nofollow noopener" target="_blank">#map</a> through <a href="https://mstdn.social/tags/logics" class="mention hashtag" rel="nofollow noopener" target="_blank">#logics</a>. I use AI for understanding the <a href="https://mstdn.social/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#documentation</a> and <a href="https://mstdn.social/tags/debugging" class="mention hashtag" rel="nofollow noopener" target="_blank">#debugging</a> purposes not for a entire <a href="https://mstdn.social/tags/mental" class="mention hashtag" rel="nofollow noopener" target="_blank">#mental</a> <a href="https://mstdn.social/tags/model" class="mention hashtag" rel="nofollow noopener" target="_blank">#model</a>. I do it for <a href="https://mstdn.social/tags/education" class="mention hashtag" rel="nofollow noopener" target="_blank">#education</a> not <a href="https://mstdn.social/tags/production" class="mention hashtag" rel="nofollow noopener" target="_blank">#production</a>.

BastilleBSD :freebsd:FreeBSD has a handbook that's actually worth reading:<a href="https://docs.freebsd.org/en/books/handbook/" rel="nofollow noopener" translate="no" target="_blank">https://docs.freebsd.org/en/books/handbook/</a>.It’s exhaustive, community-maintained, and official.<a href="https://fosstodon.org/tags/FreeBSD" class="mention hashtag" rel="nofollow noopener" target="_blank">#FreeBSD</a> <a href="https://fosstodon.org/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#documentation</a>

Vivekanandan KS :nixos:<a href="https://fosstodon.org/@PierreZ" class="u-url mention" rel="nofollow noopener" target="_blank">@PierreZ</a> Nice <a href="https://mstdn.social/tags/blog" class="mention hashtag" rel="nofollow noopener" target="_blank">#blog</a>. All the bad and ugly are not because <a href="https://mstdn.social/tags/Nix" class="mention hashtag" rel="nofollow noopener" target="_blank">#Nix</a> <a href="https://mstdn.social/tags/NixOS" class="mention hashtag" rel="nofollow noopener" target="_blank">#NixOS</a> is hard, but it's because it does things <a href="https://mstdn.social/tags/differently" class="mention hashtag" rel="nofollow noopener" target="_blank">#differently</a> than others. And the <a href="https://mstdn.social/tags/language" class="mention hashtag" rel="nofollow noopener" target="_blank">#language</a> in and itself is not that <a href="https://mstdn.social/tags/difficult" class="mention hashtag" rel="nofollow noopener" target="_blank">#difficult</a>, but have to agree that the <a href="https://mstdn.social/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#documentation</a> situation is not that great which is being solved by many <a href="https://mstdn.social/tags/community" class="mention hashtag" rel="nofollow noopener" target="_blank">#community</a> initiatives like <a href="https://mstdn.social/tags/videos" class="mention hashtag" rel="nofollow noopener" target="_blank">#videos</a> in <a href="https://mstdn.social/tags/youtube" class="mention hashtag" rel="nofollow noopener" target="_blank">#youtube</a>, <a href="https://mstdn.social/tags/blogs" class="mention hashtag" rel="nofollow noopener" target="_blank">#blogs</a>, <a href="https://mstdn.social/tags/sites" class="mention hashtag" rel="nofollow noopener" target="_blank">#sites</a> etcBut once someone got the gist of <a href="https://mstdn.social/tags/best" class="mention hashtag" rel="nofollow noopener" target="_blank">#best</a> practices way to do things, then it'll be easier to <a href="https://mstdn.social/tags/learn" class="mention hashtag" rel="nofollow noopener" target="_blank">#learn</a> and <a href="https://mstdn.social/tags/adopt" class="mention hashtag" rel="nofollow noopener" target="_blank">#adopt</a>.

Frontend DogmaHow JSDoc Saved My Dev Workflow, by (not on Mastodon or Bluesky):<a href="https://spin.atomicobject.com/how-jsdoc-saved-my-dev-workflow/" rel="nofollow noopener" translate="no" target="_blank">https://spin.atomicobject.com/how-jsdoc-saved-my-dev-workflow/</a><a href="https://mas.to/tags/jsdoc" class="mention hashtag" rel="nofollow noopener" target="_blank">#jsdoc</a> <a href="https://mas.to/tags/javascript" class="mention hashtag" rel="nofollow noopener" target="_blank">#javascript</a> <a href="https://mas.to/tags/typescript" class="mention hashtag" rel="nofollow noopener" target="_blank">#typescript</a> <a href="https://mas.to/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#documentation</a>

pvergain (framapiaf)<a href="https://framapiaf.org/tags/ty" class="mention hashtag" rel="nofollow noopener" target="_blank">#ty</a> an extremely fast <a href="https://framapiaf.org/tags/Python" class="mention hashtag" rel="nofollow noopener" target="_blank">#Python</a> type checker, written in <a href="https://framapiaf.org/tags/Rust" class="mention hashtag" rel="nofollow noopener" target="_blank">#Rust</a>.- <a href="https://docs.astral.sh/ty/" rel="nofollow noopener" translate="no" target="_blank">https://docs.astral.sh/ty/</a> - <a href="https://github.com/astral-sh/ty/commit/6a408d5f98e0d17c7b74c7eb7357de44fb105c77#:~:text=%23%23%23-,documentation,-32" rel="nofollow noopener" translate="no" target="_blank">https://github.com/astral-sh/ty/commit/6a408d5f98e0d17c7b74c7eb7357de44fb105c77#:~:text=%23%23%23-,documentation,-32</a> (<a href="https://framapiaf.org/tags/Documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#Documentation</a>, The ty documentation is now available)<a href="https://framapiaf.org/tags/python" class="mention hashtag" rel="nofollow noopener" target="_blank">#python</a> <a href="https://framapiaf.org/tags/TypeChecker" class="mention hashtag" rel="nofollow noopener" target="_blank">#TypeChecker</a> <a href="https://framapiaf.org/tags/Astral" class="mention hashtag" rel="nofollow noopener" target="_blank">#Astral</a>

Miguel Afonso Caetano"The purpose of documentation is to skill and empower someone in their craft. It serves their acquisition and application of skill.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.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.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?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."<a href="https://vurt.org/articles/my-favourite-german-word/" rel="nofollow noopener" translate="no" target="_blank">https://vurt.org/articles/my-favourite-german-word/</a><a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener" target="_blank">#TechnicalWriting</a> <a href="https://tldr.nettime.org/tags/AI" class="mention hashtag" rel="nofollow noopener" target="_blank">#AI</a> <a href="https://tldr.nettime.org/tags/GenerativeAI" class="mention hashtag" rel="nofollow noopener" target="_blank">#GenerativeAI</a> <a href="https://tldr.nettime.org/tags/LLMs" class="mention hashtag" rel="nofollow noopener" target="_blank">#LLMs</a> <a href="https://tldr.nettime.org/tags/Chatbots" class="mention hashtag" rel="nofollow noopener" target="_blank">#Chatbots</a> <a href="https://tldr.nettime.org/tags/Documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#Documentation</a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#SoftwareDocumentation</a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener" target="_blank">#TechnicalCommunication</a>

Frontend DogmaAccessibility Statements: The Good, the Bad, and the Ugly, by (not on Mastodon or Bluesky):<a href="https://buttondown.com/access-ability/archive/accessibility-statements-the-good-the-bad-and-the/" rel="nofollow noopener" translate="no" target="_blank">https://buttondown.com/access-ability/archive/accessibility-statements-the-good-the-bad-and-the/</a><a href="https://mas.to/tags/accessibility" class="mention hashtag" rel="nofollow noopener" target="_blank">#accessibility</a> <a href="https://mas.to/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#documentation</a> <a href="https://mas.to/tags/compliance" class="mention hashtag" rel="nofollow noopener" target="_blank">#compliance</a>

Recent searches

Search options

Administered by:

Server stats:

#documentation