What's wrong with AI-generated docs https://buff.ly/xAp81oX

let me tell you what’s wrong with docs and docs sets entirely generated by LLMs.

#BlueSpice 5.0 is here! Reach a new level in managing your #company #knowledge. Discover new #features like the automated #DeepL #translation or the editor for #BPMN #process diagrams.

Test BlueSpice 5.0 now in our online #demo:
https://en.demo.bluespice.com/wiki/

Overview of all new features at:
https://bluespice.com/bluespice-5-0-has-arrived/

La doc de Thymeleaf est raisonnablement bien faite, même si il y a une marche d'entrée un peu élevée à passer. https://www.thymeleaf.org/doc/tutorials/2.1/usingthymeleaf.html#introducing-thymeleaf #template #engine #java #spring #documentation #opensource

Over the past couple of months, I've been spending more time reviewing my tech notes from the last five years.

Partially out of a new interest in posting publicly & also trying to improve my writing.

Despite my placing numerous reference links & quotes in these notes, I feel that I'm really blurring the line between plagiarism, absorbing concepts & re-writing them in my own words.

These notes continue to be useful. Just can't quite place the source. A new imposter syndrome.

A lack of code documentation is killing new libraries.

Pas un, mais trois amendements déposés par des députés de la "Droite républicaine" (le groupe de Wauquiez) pour supprimer l'ABES (Agence bibliographique de l'enseignement supérieur) dans la" Simplification de la vie économique".

https://www2.assemblee-nationale.fr/recherche/resultats_recherche/(legislature)/17/(tri)/date/(typeDoc)/amendement/(query)/eyJxIjoiY29udGVudTooXCJhZ2VuY2VcIiBBTkQgXCJiaWJsaW9ncmFwaGlxdWVcIikiLCJmcSI6IiIsInJvd3MiOjEwLCJzdGFydCI6ZmFsc2UsInd0IjoicGhwIiwiaGwiOiJmYWxzZSIsImZsIjoic2NvcmUsdXJsLHRpdHJlLHVybERvc3NpZXJMZWdpc2xhdGlmLHRpdHJlRG9zc2llckxlZ2lzbGF0aWYsdGV4dGVRdWVzdGlvbix0eXBlRG9jdW1lbnQsc3NUeXBlRG9jdW1lbnQscnVicmlxdWUsdGV0ZUFuYWx5c2UsbW90c0NsZXMsYXV0ZXVyLGRhdGVEZXBvdCxzaWduYXRhaXJlc0FtZW5kZW1lbnQsZGVzaWduYXRpb25BcnRpY2xlLHNvbW1haXJlLHNvcnQifQ==

Ah, yes, the classic "blame the user" defense: Man pages are the epitome of pristine #documentation, and if you can't decipher them, it's obviously your profound incompetence. Clearly, the real issue is that you peasants insist on using those pesky programs that don’t reveal the hidden wisdom of man pages.
https://whynothugo.nl/journal/2025/04/09/man-pages-are-great-man-readers-are-the-problem/ #blameTheUser #manPages #userExperience #techHumor #programming #HackerNews #ngated

Oyez, oyez ! personnels du #CNRS #ESR et #SHS, doctorants et post-doctorants, professionnels de la conservation du patrimoine... ! Les inscriptions à la #formation « Gestion de projet sur les sources numériques en SHS » sont ouvertes jusqu’au 23 mai 2025.

https://bvh.hypotheses.org/12624

#formation #formationcontinue #numérique #ingénierie #recherche #documentation #FAIR #scienceouverte #gestiondeProjet #dataESR #PGD ...

Documentation complaints.

The Curse of Knowledge is real in documentation; even big and pricey ecosystems skip basic information.

Two examples I ran into this morning:

1. GitHub's CODEOWNERS documentation does not explicitly mention where to create the file.

https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

2. NPM's docs do not explain allowed characters in package names.

https://docs.npmjs.com/package-name-guidelines

We have updated our Python Basics tutorial to describe the guidelines for docstrings in more detail:
https://python-basics-tutorial.readthedocs.io/en/latest/document/sphinx/docstrings.html#guidelines
#Python #Documentation #DX

new & final status update on 'moving image zines rdam':

The complete archive (355 videos) from 2005-2025 has been uploaded & is available on archive.org: https://archive.org/details/moving-image-zines-rdam?sort=-date

All videos are downloadable as high-quality files [mp4/h264 codec, 32 Mbit/s] and reusable under the Creative Commons Attribution-ShareAlike 4.0 International license.

This morning, I finally checked in the code for turning a few lines of text like:

Today, Sat Apr 05, 2025
1000-1600 Cactus Sale
1100-1400 March at the Roundhouse

into text displayed on the eInk screen from WaveShare. As always, it took longer than expected, but it's mostly working. #coding #documentation #EverythingTakesLonger #YakShaving #WoodWorking… (1/3)

Well, since I was last working on my Time Machine #Pinball reverse engineering project, #Ghidra updates have blown away whatever I did to install mc6800 processor support, and of course I didn't document what I did. Time to pick up the pieces so I can actually get into the meat of the project.

Ideally this time I'll set it up so it isn't overridden when the #flatpak is updated.

#OffShore fianance created Cloud #money before we have #Cloud Computing ...

grandiose #documentation

deep inside the shadowy world of offshore finance and corporate tax avoidance, revealing how the world's largest corporations are reshaping the global economy at the expense of ordinary citizen

https://youtu.be/N6Ye04ffTpk

I've expanded the documentation for Hike (my #markdown browser/reader for the #terminal) and also moved it to its own little subdomain now:

https://hike.davep.dev/

All developers I've met in my career in IT, who insisted code is self-documenting were exceptionally bad in documenting anything

While their code usually ran just fine, they could hardly ever explain how it worked or why it was structured that way to someone else, especially junior developers.

Comments and annotations exists for a reason.

Good #Coding practices question for #Documentation:

Are there some general guidelines on what info to put in the comment at the top of each code file? Like date, author, basic description of what the code does? Maybe something about dependencies? Are there templates for this somewhere (e.g. for #Matlab or #Python if that matters)?

#documentation

so the e-bike brake handle had an OH137 hall effect sensor in its case and a magnet. Let's hope I can fix that lel