med-mastodon.com is one of the many independent Mastodon servers you can use to participate in the fediverse.
Medical community on Mastodon

Administered by:

Server stats:

347
active users

#documentation

3 posts3 participants0 posts today

Ah, behold the Magic Wormhole 🌀—because apparently, sending files in 2025 is still rocket science 🚀. With human-sized codes and a touch of "magic," you'll finally conquer the eternal struggle of file transfers. Just be sure to consult the sacred scrolls (a.k.a. documentation) to decipher this mystic art. 📜✨
magic-wormhole.readthedocs.io/ #MagicWormhole #FileTransfer #TechInnovation #TechMagic #Documentation #HackerNews #ngated

magic-wormhole.readthedocs.ioWelcome — Magic-Wormhole 0.20.0+24.g0a212b2 documentation
Replied in thread

@loganer Granted, what people call "#AI" in games is usually just some randomization and #bots that fill the gaps with pre-determined rules and steps.

  • Nothing more or less...

That doesn't necessitate any #GPU but just simple #pathfinding and #Lua code to the point that any halfassed #GameEngine does have tools to setup basic #NPC|s and make them do stuff like "beg for money" and "offer items"...

  • The problems "#AIs" are solving are easier and more efficient to be solved by either halfassed-trained minimum-wage paid humans and/or accessible #documentation and #FAQs as well as reasonable defaults...

Plusieurs mois de travail, des milliers de contributions et d'améliorations – voici venir do•doc 12 ! La nouvelle version de notre logiciel libre et gratuit de documentation collaborative.

À cette occasion, nous avons besoin de vous :

- pour tester l'installation sur Linux, Mac, Windows

- pour essayer l'ensemble des fonctionnalités

- pour nous remonter les bugs, soucis de traduction, d'accessibilité ou de compréhension

Toutes les infos sur forum.latelier-des-chercheurs.

Merci 😊

@JuBo57 @primtux
@Matthieu2villR @maupao @MathGon @julienbidoret @julieblanc @julientaq
@aurelien
@Pixflowave @raultlionel @polylogue

@ax6761 bonjour! Ici Graham P, rapporteur du bug 287569.

Royaume-Uni, deux points:

1/ il y a quelques mois, FreeBSD developers ont fait beaucoup topnotch invisible changes, without which it would have been presque impossible to not only make a "PR" (not to be confused with une pull request) mais aussi trouvez un travail-around

2/ the pictured error peut etre moins likely to occur if requirements de la systeme sont documented

3/ mon "BR" (bug report, not to be confused with une probleme report) pour documentation n'etait pas acceptable.

Oh la la. Deux ou trois. J'suis un poet et I don't know it.

<bugs.freebsd.org/bugzilla/show>

― Website: system requirements: memory/RAM: UFS and ZFS

bugs.freebsd.orgMaking sure you're not a bot!
Replied in thread

@n_dimension @jackyan granted, I've seen this "#ProfessionalMalpractice" in some cases where #IT services provider decided to refuse to provide #documentation for what they setup and how to maintain it to their customers as a form of 'not legally #extortion and #blackmail' just to shackle their customers into worsening terms…

  • Basically adding #pain and #frustration by refusing to offer graceful handovers and outbound migration assistance.

IMHO every company that engages that way with their clients should be banned and forcibly disbanded!

I must have failed somewhere, but the documentation for Traefik is NOT normal tinkerer friendly.
Legit, I have 10 tabs open just to cross-reference different parts of the web documentation and I'm utterly confused.

All the documentation focuses on either Docker or Kubernetes... I'm running essentially "bare metal" on LXC. Like, no examples for this config. Not everybody likes to use Docker.

Nowhere does it explain in the "beginner friendly" parts of their guide how to deal with YAML files, or why spaces are more important than tabs... Yuck.

Nowhere in their docs do they have a "how to read and comprehend this guide" section. I should not have to go to third party resources like YouTube or Reddit to figure out how to setup and perform basic administrative tasks for your software.

This is from some Joe on the web who can usually get away with the man pages for most GNU utils. That documentation is top tier.

I'm a salty-ass Millennial trying to Homelab here. I got plenty of other things to do than futz in documentation hell. You have Enterprises paying for support, use that to support your public facing documentation.

Replied in thread

@r @fluffykittycat @flower Obviously people have used the #RP2040 for many projects and given it's ease of programming, low price, excellent documentation and easy availability it's no wounder it does put pressue on #ATmega / #ATtiny, #Arduino, #Teensy, etc.

  • At least for low volume productions and prototypes as proof of concept.

#RaspberryPi shure are more and more targeting #embedded & #industrial clients given they do in fact disrupt the market as one can get proper #documentation and #tools without paying $$$$ upfront (AND sign NDAs) just to be able to boot #Linux on it.

  • And competitors fail at understanding that this makes #Broadcom look good and is their entry-way into acquiring new clients. Because selling hardware purely off specs may work in #amd64 land where shit's legacy and the way things work is so entrenched that basic stuff just works as in booting. #ARM and even #ARM64 fail at having that level of #standardization.

OFC the #Pi0 / #Pi0W / #Pi0W2 doesn't need to innovate since every competitor isn't even trying to compete but merely farting out boards with 0 documentation and some halfassed boot images and no post-sales support so they keep dominating by virtue of being the only ones that just work...

Serious question for those using #AI to write code comments and code #documentation :

Isn't the kind of documentation it generates trivial?

I mean: if you are just describing what a method or class do, I can read that on the (clean) code myself. I don't need that repeated.

What I am interested in is the parts I can't infer from a quick read of the code. Why this decision was made. Why this method looks weird. Why this class hierarchy. Why this code that seems useless can't be deleted.

"In the case of tech writing, thinking that you’re creating docs when what you’re doing is dumping words into a file is particularly wrong, because docs have a moral obligation to solve needs.
(...)
Creating a tutorial aimed at beginners without knowing what the beginner thinks is an empty gesture. Consider any such tutorial in the wild: If instead of following the inviting form of a tutorial it had been written like an entry from a dev diary, it would have offered a more sincere experience, one that would have signaled to the reader that this content wasn’t really for them after all. You can deal with the curse of knowledge either by becoming a beginner, or by not pretending you’re talking to one (that’s why someone like John Carmack is honest).

Unfortunately, organizations often don’t care about the quality of their content (performative or not), and while they might have perceived the signs that they need tech writers, they might still ask folks to create documentation to fulfill a goal or satisfy their particular Definition of Done. Sometimes we can’t escape the script that’s being forced onto ourselves, but, while the fake author in Annie’s post has a cruel side in that it’s utterly devoid of empathy, you can choose not to be like it. This is the duty of tech writers: to uphold clarity and defend user comprehension in all situations where tech comms risk becoming faux."

passo.uno/documentation-theate

passo.uno · When docs become performance art, everybody losesYou might have read Annie Mueller’s post poking fun at developers’ tutorials. If you haven’t yet, do it now. On the surface, it’s an exquisite rendition of the kind of technobabble we tech writers get to tame every day. Reactions among devs ranged from nervous snickering to outright shame. Like all the best parodies, Annie’s goes deeper than that, though: It puts a finger on what I call “documentation theatre”, that is, a state where docs are performative and not addressing a need nor caring about it. Let me explain why I think writing docs because you are forced to is a bigger issue than not having docs at all.

I'm all against irresponsible uses of LLMs, but users probably wouldn't turn to a natural language prompt to get a properly understandable doc if the documentation effort was decent enough upstream.

Documentation is hard and boring most of the time, but it's what makes your product usable. Bad doc is plain gatekeeping.