andi1984.devAndi1984
Mehr von 
Andreas Sander
Verwaltet von:
#docs
0 Beiträge0 Beteiligte0 Beiträge heute
Antwortete im Thread
@heiseonline @c-t-das-magazin-f-r-computertechnik-heiseonline Und in den letzten 36 Monaten haben sie es soweit getrieben, daß ich die Produkte nun vollständig meide.
"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."
passo.uno · How I write docs quicklyI’ve been writing documentation and technical articles for more than a decade now. One piece of feedback I consistently got from managers and peers during all these years is how fast I am when producing and releasing docs. For example, I was once asked to document a new feature from a team I wasn’t serving two weeks ahead of launch. Everything was new to me, but I had most of the docs drafted after four days. By launch, the docs had been deemed ready to go live.
Basic 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?
Typemill 2.18.0 is out with a sleek, redesigned AI interface and powerful new features like hiding restricted pages from your navigation. Dive into the full update: https://typemill.net/news/typemill-2-18-0-kixote-redesign
Microsoft Learn Contributor Chatmode | by Luke Murray.
https://luke.geek.nz/azure/microsoft-learn-contributor-chatmode/
luke.geek.nz · Microsoft Learn Contributor Chatmode | luke.geek.nzExplore Microsoft Learn Contributor Chat mode to enhance your documentation skills while adhering to the Microsoft Writing Style Guide.
Google is adding gems to the Gemini side panel in Gmail, Docs, and other workspace apps
https://www.newstainmentora.online/2025/07/google-is-adding-gems-to-gemini-side.html
#google #Gemini #googlegemini #gmail #docs #workspace #ai #ArtificialIntelligence
NewsTainmentOra · Google is adding gems to the Gemini side panel in Gmail, Docs, and other workspace apps
nsysctl 2.2 is out!
New features and improvements:
https://alfonsosiciliano.gitlab.io/posts/2025-06-28-nsysctl-2-2.html
Manual and tutorial already updated!
#documentation #docs #manual #tutorial
Port update in progress sysutils/nsysctl
#FreeBSD #UNIX #sysadmin #sysctl #HappyHacking #runbsd 
#OpenSource
"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?
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."
passo.uno · Things technical writers shouldn't care about... yetStrategy, Michael Porter wrote, is choosing what not to do. Now, the problem with knowledge work such as the one tech writers carry out is that it’s full of things that seem to require equally important, time-consuming decisions. While engaging in lengthy disquisitions might be alluring, endlessly combing the Zen garden of theory doesn’t solve the basic problem of the docs hierarchy of needs, which is writing the damn docs and making sure they’re accurate, useful, and easy to follow.
For anyone who wonders about the absence of system requirements for FreeBSD:
― the two bug reports linked from https://www.reddit.com/r/freebsd/comments/1lcm1ze/freebsd_system_requirements/ may be of interest.
I reopened the first report following premature rejection.
Rejection of the second report is a concern, but not my concern. In the absence of documentation, everyone loses.
Docs, l’éditeur de texte libre et collaboratif de La Suite numérique, a été reconnu "bien public numérique" (Digital Public Good) par la Digital Public Goods Alliance ce matin à l’ONU lors de la semaine Open Source des Nations Unies.
https://www.digitalpublicgoods.net/r/docs-collaborative-text-editing
Ce label marque une étape importante pour ce logiciel issue du partenariat franco-allemand-néerlandais 
#LogicielsLibres #OpenSource #DigitalPublicGoods #ONU #Europe #Docs #SouverainetéNumérique
The Microsoft Docs MCP Server has shipped and provides AI assistants with real-time access to official Microsoft documentation.
Check it out on GitHub here: https://github.com/MicrosoftDocs/mcp
GitHubGitHub - MicrosoftDocs/mcpContribute to MicrosoftDocs/mcp development by creating an account on GitHub.
What is the de facto standard for creating static #documentation websites for #OpenSource libraries? So far I've found #Docusaurus and #MkDocs, which both are popular options. I like that MkDocs' sources are #Markdown files. What else should I consider? Any suggestions?
Gemeinsam Open-Source-Apps entwickeln, um Europas Digitale Souveränität zu stärken – das stand vom 2. – 4. Juni im Mittelpunkt der #HackDays in Paris mit besonderem Fokus auf kollaborative Tools für die tägliche Zusammenarbeit.
Neben dem ZenDiS nahm auch unser openDesk-Partner #OpenProject am Hackathon teil: @openproject integrierte Task-Management-Features zwischen dem von @dinum und uns entwickelten #Docs und seiner eigenen Projektmanagement-Anwendung – und gewann die Zweitplatzierung 
1/3
New entry in #curated #creators on https://tube.inlinestyle.it/ we decided to surface the work of @trom as they have a great vlog on #vanlife
#peertube and the #fediverse have a lot of #technology content, and it's great to be able to surface the gems on other topics too.
If you have an https://www.inlinestyle.it account you can subscribe to their content at https://tube.inlinestyle.it/c/tromhome@videos.trom.tf/videos
Beats of Rage is now playable for free in #cloud #gaming on https://gaming.inlinestyle.it
We work hard to make accessible new #games based on #opensource software every month. Subscribers also get cloud saves to continue their session everywhere and any time they want.
Come try the #degoogle alternative for everyday services ( #email #video #music #gaming #docs ) and let us know what you think!
gaming.inlinestyle.itInlineStyle Gaming
For a sovereign digital Europe, collaboration between public institutions and open source communities is key.
Next week, we’ll join #HackDays in Paris (June 2–4), organized by #DINUM.
Our goal: integrate task management into #Docs, the French open source note-taking tool.
Learn more about our mission (French version available):
https://www.openproject.org/blog/hack-days-hackathon-2025/
OpenProject.org · For a sovereign digital Europe: OpenProject at HackDays ParisAt HackDays 2025 in Paris, OpenProject teams up with the French-built Docs app to prototype a new integration. Learn how this collaboration strengthens open source software in Europe and supports digital sovereignty.