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:

192
active users

eupolicy.social: AboutProfiles directoryPrivacy policy

Mastodon: AboutGet the appKeyboard shortcutsView source codev4.4.1

#documentation

2 posts2 participants0 posts today
Kevin Bowen 🐭<p>Going to try and take <a href="https://hachyderm.io/tags/qownotes" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>qownotes</span></a> for a test drive, this week, in managing my Markdown documentation files. Obsidian is simply too bloated of an Electron app<br>for my potato of a laptop to be of any use to me. Hopefully, this trial goes better.</p><p>They've just recently updated their repos to support <a href="https://hachyderm.io/tags/Debian" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Debian</span></a> <a href="https://hachyderm.io/tags/trixie" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>trixie</span></a>. </p><p>Would be interested to hear feedback from other folks on their experience with the app. </p><p><a href="https://hachyderm.io/@qownnotes@social.qownnotes.org/115063103869445136" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">hachyderm.io/@qownnotes@social</span><span class="invisible">.qownnotes.org/115063103869445136</span></a></p><p><a href="https://hachyderm.io/tags/Markdown" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Markdown</span></a> <a href="https://hachyderm.io/tags/Documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Documentation</span></a> <a href="https://hachyderm.io/tags/Obsidian" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Obsidian</span></a></p>
marc, trudy dinks<p>I see some people are working on pretty themes for it. Good for them, but which saint of the church of libre software is going to organize some well throught-through user-facing documentation?</p><p><a href="https://tenforward.social/tags/grub" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>grub</span></a> <a href="https://tenforward.social/tags/linux" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>linux</span></a> <a href="https://tenforward.social/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>documentation</span></a> <a href="https://tenforward.social/tags/floss" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>floss</span></a></p>
Inautilo<p><a href="https://mastodon.social/tags/Development" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Development</span></a> <a href="https://mastodon.social/tags/Launches" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Launches</span></a><br>Launching MDN’s new front end · “Redesigned and reengineered from the ground up.” <a href="https://ilo.im/166971" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://</span><span class="">ilo.im/166971</span><span class="invisible"></span></a></p><p>_____<br><a href="https://mastodon.social/tags/Mozilla" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Mozilla</span></a> <a href="https://mastodon.social/tags/MDN" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>MDN</span></a> <a href="https://mastodon.social/tags/Documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Documentation</span></a> <a href="https://mastodon.social/tags/WebPlatform" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>WebPlatform</span></a> <a href="https://mastodon.social/tags/Browser" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Browser</span></a> <a href="https://mastodon.social/tags/WebDev" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>WebDev</span></a> <a href="https://mastodon.social/tags/Frontend" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Frontend</span></a> <a href="https://mastodon.social/tags/HTML" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>HTML</span></a> <a href="https://mastodon.social/tags/CSS" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>CSS</span></a> <a href="https://mastodon.social/tags/JavaScript" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>JavaScript</span></a></p>
Miguel Afonso Caetano<p>Documentation is not trivial and AI-generated documentation sucks. As a technical writer, I find somewhat offensive this kind of pretentiousness from software developers. Documentation needs context, intentions, AND real-life use cases. And why the hell would you want to "synthesize documentation"? When you have great information architecture as well as supporting videos, there's no need to synthesize anything at all for the users.</p><p>"Clearly LLMs are useful to software engineers. They can quickly generate code, and they are excellent at synthesizing requirements and documentation. For some tasks this is enough: the requirements are clear enough, and the problems are simple enough, that they can one-shot the whole thing.</p><p>That said, for anything non-trivial, they are not capable of maintaining enough context accurately enough to iterate to a working solution. You, the software engineer, are responsible for ensuring that the requirements are clear, and that the code actually does what it purports to do."</p><p><a href="https://zed.dev/blog/why-llms-cant-build-software" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">zed.dev/blog/why-llms-cant-bui</span><span class="invisible">ld-software</span></a></p><p><a href="https://tldr.nettime.org/tags/AI" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>AI</span></a> <a href="https://tldr.nettime.org/tags/GenerativeAI" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>GenerativeAI</span></a> <a href="https://tldr.nettime.org/tags/LLMs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>LLMs</span></a> <a href="https://tldr.nettime.org/tags/Programming" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Programming</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDevelopment" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>SoftwareDevelopment</span></a> <a href="https://tldr.nettime.org/tags/Chatbots" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Chatbots</span></a> <a href="https://tldr.nettime.org/tags/Documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Documentation</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>SoftwareDocumentation</span></a></p>
Eva Winterschön<p>🚯 No More Markdown 🚯</p><p>Well, it's certainly not going away any time soon, but it doesn't have to be the default. While it's easily a majority of the docs formats that I have to use, it's not my favorite. </p><p>Perhaps in an ideal world it would be AsciiDoc or LaTeX _All The Time_, but we don't live in that world, oh well 💋 </p><p>In the interim, here's someone who wrote about the topic which seems worth sharing. Interesting points, ja?</p><p>- Why You Shouldn’t Use “Markdown” for Documentation: <a href="https://ericholscher.com/blog/2016/mar/15/dont-use-markdown-for-technical-docs/" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">ericholscher.com/blog/2016/mar</span><span class="invisible">/15/dont-use-markdown-for-technical-docs/</span></a></p><p><a href="https://mastodon.bsd.cafe/tags/engineering" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>engineering</span></a> <a href="https://mastodon.bsd.cafe/tags/software" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>software</span></a> <a href="https://mastodon.bsd.cafe/tags/oss" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>oss</span></a> <a href="https://mastodon.bsd.cafe/tags/foss" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>foss</span></a> <a href="https://mastodon.bsd.cafe/tags/markdown" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>markdown</span></a> <a href="https://mastodon.bsd.cafe/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>documentation</span></a></p>
Some Bits: Nelson's Linkblog<p>git manpage generator: A parody, something generating plausible but fictional documentation for git<br><a href="https://git-man-page-generator.lokaltog.net/#bWFzc2FnZSQkYmFyZSByZXBvc2l0b3J5" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">git-man-page-generator.lokalto</span><span class="invisible">g.net/#bWFzc2FnZSQkYmFyZSByZXBvc2l0b3J5</span></a><br> <a href="https://tech.lgbt/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>documentation</span></a> <a href="https://tech.lgbt/tags/funny" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>funny</span></a> <a href="https://tech.lgbt/tags/dvcs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>dvcs</span></a> <a href="https://tech.lgbt/tags/unix" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>unix</span></a> <a href="https://tech.lgbt/tags/git" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>git</span></a> <a href="https://tech.lgbt/tags/vcs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>vcs</span></a> #+</p>
The Technical Editor<p>Struggling with technical writing? ✍️</p><p>This video on the Editor's Toolkit shows you the essential software and resources to improve clarity, speed up your workflow, and collaborate better.</p><p>I cover:<br>✅ Grammar &amp; style checkers<br>✅ Style guides &amp; terminology management<br>✅ Collaboration platforms<br>✅ Version control</p><p>Watch here to make your technical documents shine! <br><a href="https://youtu.be/KJ8DWjVLa9I" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://</span><span class="">youtu.be/KJ8DWjVLa9I</span><span class="invisible"></span></a></p><p><a href="https://hachyderm.io/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>TechnicalWriting</span></a> <a href="https://hachyderm.io/tags/Documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Documentation</span></a> <a href="https://hachyderm.io/tags/TechTools" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>TechTools</span></a> <a href="https://hachyderm.io/tags/ContentStrategy" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>ContentStrategy</span></a></p>
Carlo Zottmann<p>Oh hey, that looks *useful*! <br><a href="https://mastodon.social/@steipete/114982119853883518" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">mastodon.social/@steipete/1149</span><span class="invisible">82119853883518</span></a></p><p><a href="https://norden.social/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>documentation</span></a> <a href="https://norden.social/tags/llm" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>llm</span></a> <a href="https://norden.social/tags/apple" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>apple</span></a> <a href="https://norden.social/tags/macOS" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>macOS</span></a> <a href="https://norden.social/tags/iOS" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>iOS</span></a></p>
Joche Ojeda<p>DevExpress Documentations is now accessible as an MCP server</p><p><a href="https://www.jocheojeda.com/2025/08/05/devexpress-documentations-is-now-accessible-as-an-mcp-server/" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://www.</span><span class="ellipsis">jocheojeda.com/2025/08/05/deve</span><span class="invisible">xpress-documentations-is-now-accessible-as-an-mcp-server/</span></a></p><p><a href="https://mastodon.social/tags/DevExpress" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>DevExpress</span></a> <a href="https://mastodon.social/tags/GitHubCopilot" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>GitHubCopilot</span></a> <a href="https://mastodon.social/tags/MCPserver" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>MCPserver</span></a> <a href="https://mastodon.social/tags/VisualStudio" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>VisualStudio</span></a> <a href="https://mastodon.social/tags/VSCode" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>VSCode</span></a> <a href="https://mastodon.social/tags/XAF" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>XAF</span></a> <a href="https://mastodon.social/tags/AIdevelopment" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>AIdevelopment</span></a> <a href="https://mastodon.social/tags/Microsoft" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Microsoft</span></a> <a href="https://mastodon.social/tags/agentmode" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>agentmode</span></a> <a href="https://mastodon.social/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>documentation</span></a> <a href="https://mastodon.social/tags/codingassistant" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>codingassistant</span></a> <a href="https://mastodon.social/tags/developertools" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>developertools</span></a> <a href="https://mastodon.social/tags/programming" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>programming</span></a> <a href="https://mastodon.social/tags/NETdevelopment" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>NETdevelopment</span></a> <a href="https://mastodon.social/tags/artificialintelligence" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>artificialintelligence</span></a></p>
Interesting Links<p><strong><a href="https://www.debian.org/releases/trixie/release-notes/index.en.html" rel="nofollow noopener" target="_blank">Release Notes for Debian 13 (trixie)</a></strong></p><p><a href="https://bookmarks.kvibber.com/tagged/Linux" class="mention hashtag" rel="nofollow noopener" target="_blank">#Linux</a> <a href="https://bookmarks.kvibber.com/tagged/Debian" class="mention hashtag" rel="nofollow noopener" target="_blank">#Debian</a> <a href="https://bookmarks.kvibber.com/tagged/DebianTrixie" class="mention hashtag" rel="nofollow noopener" target="_blank">#DebianTrixie</a> <a href="https://bookmarks.kvibber.com/tagged/Documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#Documentation</a></p>
PHP<p>🐘 We recently introduced WASM runnable-examples in the manual.</p><p>An example: <a href="https://www.php.net/manual/en/language.operators.assignment.php" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://www.</span><span class="ellipsis">php.net/manual/en/language.ope</span><span class="invisible">rators.assignment.php</span></a></p><p>We only enabled it for sections where we know the examples work, as they were not always written with runability in mind.</p><p>ℹ️ We need to evaluate each section on <a href="https://github.com/php/doc-en/issues/4799" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">github.com/php/doc-en/issues/4</span><span class="invisible">799</span></a>, and verify the examples, whether they need a fix, or need other tweaks to make it work.</p><p>For the random extension, this is what I did: <a href="https://github.com/php/doc-en/commit/1bcc40f8134305cbebf6c8378ee7e5fc8c569674" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">github.com/php/doc-en/commit/1</span><span class="invisible">bcc40f8134305cbebf6c8378ee7e5fc8c569674</span></a></p><p>❓ Will you help?</p><p><a href="https://fosstodon.org/tags/php" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>php</span></a> <a href="https://fosstodon.org/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>documentation</span></a> <a href="https://fosstodon.org/tags/OpenSource" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>OpenSource</span></a></p>
pandoc<p>The Emacs Org-mode format offers to keep “your life in plain text”. It is a very powerful format with many configuration options.<br>Pandoc supports a decent subset of Org-mode. Due to the complexity, we maintain an extra page that lists the supported features, how they are translated into pandoc's document model, and explains ways to control and extend the conversion process.<br><a href="https://pandoc.org/org.html" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://</span><span class="">pandoc.org/org.html</span><span class="invisible"></span></a></p><p><a href="https://fosstodon.org/tags/pandoc" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>pandoc</span></a> <a href="https://fosstodon.org/tags/orgmode" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>orgmode</span></a> <a href="https://fosstodon.org/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>documentation</span></a></p>
BookStack<p>BookStack v25.07 is now here with a bundle of improvements:</p><p>📝 Markdown Plaintext Input Option<br>✏️ New Comment/Description Editor<br>🔧 New WYSIWYG Editor Improvements<br>📋 Improved Changelog Input<br>📦 ZIP Import/Export API Endpoints<br>🏷️ Parent Tag Classes<br>📱 Multi-Column Layout Refinements<br>🔐 Better Permission Generation<br>🌍 Nepali Language &amp; Updates</p><p><a href="https://www.bookstackapp.com/blog/bookstack-release-v25-07/" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://www.</span><span class="ellipsis">bookstackapp.com/blog/bookstac</span><span class="invisible">k-release-v25-07/</span></a></p><p><a href="https://fosstodon.org/tags/Documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Documentation</span></a> <a href="https://fosstodon.org/tags/SelfHosted" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>SelfHosted</span></a> <a href="https://fosstodon.org/tags/OpenSource" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>OpenSource</span></a> <a href="https://fosstodon.org/tags/KnowledgeManagement" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>KnowledgeManagement</span></a></p>
Karsten Schmidt<p>A massive shout out and gratitude to <span class="h-card" translate="no"><a href="https://mastodon.social/@brandtryan" class="u-url mention" rel="nofollow noopener" target="_blank">@<span>brandtryan</span></a></span> for being a superstar and manually reviewing and comparing the expected outputs of the hundreds of code examples &amp; snippets included in the readmes and documentation of the <a href="https://mastodon.thi.ng/tags/ThingUmbrella" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>ThingUmbrella</span></a> repo. Over the past weeks he submitted dozens of issues with discrepancies, which I now have 99% updated/fixed (I hope)...</p><p>Thank you, thank you! 😍</p><p>FYI. The snippet extraction system is based on <a href="https://thi.ng/tangle" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://</span><span class="">thi.ng/tangle</span><span class="invisible"></span></a>, which allows you to extract runnable code examples from code blocks in <a href="https://mastodon.thi.ng/tags/Markdown" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Markdown</span></a> files and from docstrings in source files. More info about this feature &amp; process here:</p><p><a href="https://github.com/thi-ng/umbrella/blob/develop/README.md#extracting-code-examples-from-readme-files--comments" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">github.com/thi-ng/umbrella/blo</span><span class="invisible">b/develop/README.md#extracting-code-examples-from-readme-files--comments</span></a></p><p><a href="https://mastodon.thi.ng/tags/OpenSource" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>OpenSource</span></a> <a href="https://mastodon.thi.ng/tags/Documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Documentation</span></a></p>
Inautilo<p><a href="https://mastodon.social/tags/Development" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Development</span></a> <a href="https://mastodon.social/tags/Anniversaries" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Anniversaries</span></a><br>MDN turns 20 · Celebrating its renowned web technology documentation <a href="https://ilo.im/165mhl" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://</span><span class="">ilo.im/165mhl</span><span class="invisible"></span></a></p><p>_____<br><a href="https://mastodon.social/tags/Mozilla" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Mozilla</span></a> <a href="https://mastodon.social/tags/MDN" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>MDN</span></a> <a href="https://mastodon.social/tags/Documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Documentation</span></a> <a href="https://mastodon.social/tags/WebPlatform" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>WebPlatform</span></a> <a href="https://mastodon.social/tags/Browser" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Browser</span></a> <a href="https://mastodon.social/tags/WebDev" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>WebDev</span></a> <a href="https://mastodon.social/tags/Frontend" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Frontend</span></a> <a href="https://mastodon.social/tags/HTML" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>HTML</span></a> <a href="https://mastodon.social/tags/CSS" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>CSS</span></a> <a href="https://mastodon.social/tags/JavaScript" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>JavaScript</span></a></p>
Miguel Afonso Caetano<p>"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.</p><p>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.</p><p>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."</p><p><a href="https://passo.uno/how-write-tech-docs-quickly/" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">passo.uno/how-write-tech-docs-</span><span class="invisible">quickly/</span></a></p><p><a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>TechnicalWriting</span></a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>TechnicalCommunication</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>SoftwareDocumentation</span></a> <a href="https://tldr.nettime.org/tags/SoftwareDevelopment" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>SoftwareDevelopment</span></a> <a href="https://tldr.nettime.org/tags/Programming" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Programming</span></a> <a href="https://tldr.nettime.org/tags/Docs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Docs</span></a> <a href="https://tldr.nettime.org/tags/Documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Documentation</span></a></p>
Miguel Afonso Caetano<p>Basic Questions That Every (Technical) Writer Should Try To Answer - AKA Technical Writing 101: </p><p>I assure you that If you can answer all of these questions, your readers won't mistake you for a chatbot :)</p><p>1. What is the purpose of the document that I'm writing?</p><p>2. Why am I writing this document?</p><p>3. Who is the target audience of this document?</p><p>4. Is this document part of a series of documents?</p><p>5. If so, have I established a nexus to the other documents in the series?</p><p>6. Are there any predefined formal requirements that the document must meet?</p><p>7. Does the document meet those requirements?</p><p>8. Does the document include an introduction?</p><p>9. Does the introduction clearly explain the purpose of the document to the target audience?</p><p>10. Does the introduction present the topics that will be explored in the body of the document in a straightforward way?</p><p>11. Does the document include a conclusion?</p><p>12. Does the conclusion provide a good summary of the previously explored topics?</p><p>13. Does the conclusion tell readers what they should have learned by following the document?</p><p>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?</p><p>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?</p><p><a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>TechnicalWriting</span></a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>TechnicalCommunication</span></a> <a href="https://tldr.nettime.org/tags/Writing" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Writing</span></a> <a href="https://tldr.nettime.org/tags/Nonfiction" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Nonfiction</span></a> <a href="https://tldr.nettime.org/tags/Documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Documentation</span></a> <a href="https://tldr.nettime.org/tags/Docs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Docs</span></a></p>
Franck ☠️<p>[OT] PHPDocumentor vs Doxygen<br><a href="https://mstdn.nrkn.fr/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>documentation</span></a> <a href="https://mstdn.nrkn.fr/tags/d%C3%A9veloppement" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>développement</span></a> <a href="https://mstdn.nrkn.fr/tags/PHP" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>PHP</span></a><br><a href="https://open-time.net/post/2025/07/20/PHPDocumentor-vs-Doxygen" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">open-time.net/post/2025/07/20/</span><span class="invisible">PHPDocumentor-vs-Doxygen</span></a></p>
Frank<p>‘He told us to just tell the truth’ – behind a revealing Billy Joel documentary</p><p>In 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</p><p><a href="https://www.theguardian.com/music/2025/jul/17/billy-joel-documentary-hbo" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://www.</span><span class="ellipsis">theguardian.com/music/2025/jul</span><span class="invisible">/17/billy-joel-documentary-hbo</span></a></p><p><a href="https://masto.nu/tags/News" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>News</span></a> <a href="https://masto.nu/tags/Music" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Music</span></a> <a href="https://masto.nu/tags/BillyJoel" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>BillyJoel</span></a> <a href="https://masto.nu/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>documentation</span></a> <a href="https://masto.nu/tags/AndSoItGoes" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>AndSoItGoes</span></a> <a href="https://masto.nu/tags/Music" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Music</span></a></p>
Kevin Karhan :verified:<p>And yes, whoever uses <a href="https://infosec.space/tags/discord" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>discord</span></a> for <a href="https://infosec.space/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>documentation</span></a> and <a href="https://infosec.space/tags/versioning" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>versioning</span></a> instead of a goddam <a href="https://infosec.space/tags/git" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>git</span></a> [doesn't have to be <span class="h-card" translate="no"><a href="https://infosec.exchange/@github" class="u-url mention" rel="nofollow noopener" target="_blank">@<span>github</span></a></span> / <a href="https://infosec.space/tags/GitHub" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>GitHub</span></a> or <span class="h-card" translate="no"><a href="https://mastodon.social/@gitlab" class="u-url mention" rel="nofollow noopener" target="_blank">@<span>gitlab</span></a></span> / <a href="https://infosec.space/tags/GitLab" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>GitLab</span></a> or <span class="h-card" translate="no"><a href="https://social.anoxinon.de/@Codeberg" class="u-url mention" rel="nofollow noopener" target="_blank">@<span>Codeberg</span></a></span> / <a href="https://infosec.space/tags/Codeberg" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Codeberg</span></a> or even <span class="h-card" translate="no"><a href="https://social.gitea.io/@gitea" class="u-url mention" rel="nofollow noopener" target="_blank">@<span>gitea</span></a></span> / <a href="https://infosec.space/tags/Gitea" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Gitea</span></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">#<span>Markdown</span></a> or goddamn ASCII plain text <em>FFS</em>] should be banned for life from <a href="https://infosec.space/tags/coding" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>coding</span></a>, working in <a href="https://infosec.space/tags/IT" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>IT</span></a> or contribute to <a href="https://infosec.space/tags/FLOSS" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>FLOSS</span></a>. </p><ul><li>Because it's <em>literally worse</em> than people shitting <em>"<a href="https://infosec.space/tags/Ai" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Ai</span></a>" <a href="https://infosec.space/tags/Slop" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Slop</span></a></em> all over the place cuz that can be <em>fixed</em> faster and easier by <em>backrolling said commits</em> and <em>banning the offender</em>! </li></ul><p><a href="https://www.youtube.com/watch?v=9ehLMlVTRJM&amp;t=992" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://www.</span><span class="ellipsis">youtube.com/watch?v=9ehLMlVTRJ</span><span class="invisible">M&amp;t=992</span></a></p><p><a href="https://infosec.space/tags/AIslop" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>AIslop</span></a> <a href="https://infosec.space/tags/Enshittification" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Enshittification</span></a></p>
TrendingLive feeds
About