Elektrine
Log in Register

#documentation

22 posts · Last used 16d

Back to Timeline
jarko
jarko @jarko@hometech.social · Jul 29, 2026
Documentation is what you write for the future stranger who has the password, SSH access, and the confidence of someone who definitely knows what they are doing. A note about what changed, where the backup lives, or how to undo it can turn a late-night incident from archaeology into a boring task. Boring is the feature. #sysadmin #documentation #homelab
8
0
2
oliverzehentleitner
Oliver Zehentleitner @oliverzehentleitner@burningboard.net · Jul 29, 2026
Someone “cleaned up” the workaround. The code looked simpler. Then the production bug came back. That strange delay was not just ugly code. It carried knowledge: The upstream API could replay the same order unless the request was handled carefully. But the reason existed only in someone’s head. Keep the Why is an agent skill that captures this kind of rationale as a natural by-product of development and stores it as versioned Markdown inside the project. So before the next developer or agent removes the workaround, they can see: • why it exists • what was already tried • what could break • what must change before it can safely be removed Legacy does not begin when code gets old. It begins when the reason disappears. Free and open source: https://keepthewhy.com/ What “ugly” workaround in your codebase is actually carrying important knowledge? #OpenSource #AIEngineering #DeveloperTools #SoftwareEngineering #CodingAgents #ContextEngineering #TechnicalDebt #Documentation
0
0
0
oliverzehentleitner
Oliver Zehentleitner @oliverzehentleitner@burningboard.net · Jul 28, 2026
Keep the Why started with a simple idea: AI-assisted development already produces valuable reasoning — but most of it disappears when the conversation ends. It has since evolved far beyond rationale capture. The new article explains how Keep the Why became repository-native project memory for humans and AI agents: • continuous capture during development • retrospective recovery for existing codebases • knowledge-transfer interviews • maintenance of stale context • explicit evidence and status labels • abandoned changes without a diff • prompt-injection protection through a clear trust boundary The most important principle: Project knowledge may influence reasoning. It must never grant authority to an agent. And it still needs no database, daemon, dashboard, or external service. Just Markdown, Git, humans, and agents working with the same project knowledge. Read the article: https://blog.technopathy.club/keep-the-why-project-memory-for-humans-and-ai-agents #AI #AIAgents #SoftwareEngineering #OpenSource #DevSecOps #Documentation
0
0
0
jordikroon
Jordi Kroon @jordikroon@phpc.social · Jul 26, 2026

Exciting news for PHP documentation contributors: "php/docbook-cs" now has an auto-fixer! 🎉

docbook-cs --fix

All credit goes to Nick, who did all the work to make this happen. 🙌

This should make life easier for maintainers and lower the barrier for newcomers: fewer style nitpicks, faster reviews, and more focus on improving the docs.

Repo: http://github.com/php/docbook-cs

#PHP #PHPDocs #Documentation #Opensource

0
0
0
kdkorte
Kevin Dominik Korte @kdkorte@fosstodon.org · Jul 15, 2026
My Linux User Group had an interesting discussion about whether user manuals need to be more user-friendly. One of the points raised was that it isn't needed because AI can simplify anything written down. On the other side were those saying that software engineering gets better if you are forced to write documentation. #AI #documentation
3
1
2
katzenmann
Katzenmann / Catperson @katzenmann@c3d2.social · Jul 14, 2026

RE: https://c3d2.social/@katzenmann/116827372997387394

WOOOO! This is actually a new feature in #git 2.55!

There's now the git history fixup command which does exactly what this alias does.

https://git-scm.com/docs/git-history#Documentation/git-history.txt-fixupcommit

Also look at git history reword and git history split

0
1
0
opensuse
openSUSE Linux @opensuse@fosstodon.org · Jul 07, 2026
Want to make #openSUSE even better? Discover where you fit; #packaging, testing, #documentation, #design, and more. There's a place for everyone to contribute! #Linux 💚 contribute.opensuse.org
10
0
5
novabrooks
Nova Brooks ✨ @novabrooks@selfhosted.cafe · Jun 28, 2026
Good open source documentation has this quality where you can almost hear the developer's voice. Not formal, not robotic — just someone who understood the thing and wanted you to understand it too. The best docs are basically a friend explaining something over coffee. #OpenSource #Documentation
0
0
0
wendythedruid
wendythedruid @wendythedruid@thistlenfern.org · May 07, 2026
Replying to @wendythedruid@thistlenfern.org
Find one document—a letter, a photograph, a receipt—that proves someone before you existed and kept moving. Hold it for sixty seconds. History is not abstract when it has a texture. The archive that matters starts in your hands. https://twp.ai/4hr1bg #History #Memory #QueerArchives #FamilyHistory #Documentation #KeepGoing #Trans #Queer #LGBTQIA+
0
2
0
simskij
Simme @simskij@hachyderm.io · Apr 29, 2026
The cost of skipping ADRs used to be recoverable: slow onboarding, an archaeology session before touching brittle code, a thread that could have been a two-paragraph doc. With agents, the full cost of a missing paper trail is paid every time the session terminates. On documentation, intent debt, and why writing is now infrastructure: https://simme.dev/posts/the-end-of-just-ask-sarah/ #documentation #softwareengineering #ai
1
0
2
djwfyi__dup_32133
Daryl the Admin @djwfyi__dup_32133@vmst.io · Mar 07, 2026
As it turns out, I have Thoughts and Opinions about docs. Who knew? Amazing what years and years of doing something and building a skill (no, not the Clause kind) does #WriteTheDocs #documentation #docs
3
0
0