Yet another #documentation format but this one comes from a world of magnets and miracles #rakulang #litterateProgramming. https://coderlegion.com/9768/rakudoc-more-than-just-a-documentation-markup
@SReyCoyrehourcq @raphaellek
@khinsen
alcinnz
boosted
I want to collect examples of usability improvements in open source projects for opensourcedesign.net: improvements in labels/microcopy, better layouts of dialogs or new features which improved usability.
Do you know of good examples that are small and easy to understand?
(It is not hard to find examples in general, but they often need depper domain knowledge, are focussed on new functionality more than on improvement of usability) //jd
I want to collect examples of usability improvements in open source projects for opensourcedesign.net: improvements in labels/microcopy, better layouts of dialogs or new features which improved usability.
Do you know of good examples that are small and easy to understand?
(It is not hard to find examples in general, but they often need depper domain knowledge, are focussed on new functionality more than on improvement of usability) //jd
Konrad Hinsen
boosted
At over a thousand pages the Common Lisp specification is a thick document but that space is worth it, especially the many welcome examples. The Common Lisp Interface Manager (CLIM) specification is about a third that long and has nearly no examples, which makes the many concepts and features harder to understand.
Examples are underrated in software documentation.
https://www.lispworks.com/documentation/HyperSpec/Front
At over a thousand pages the Common Lisp specification is a thick document but that space is worth it, especially the many welcome examples. The Common Lisp Interface Manager (CLIM) specification is about a third that long and has nearly no examples, which makes the many concepts and features harder to understand.
Examples are underrated in software documentation.
https://www.lispworks.com/documentation/HyperSpec/Front
Scott Jenson
boosted
Bose released the API documentation for speakers that reached the end-of-support and updated the accompanying app to work offline. Which is great compared to other companies, but as the article says, also "is the least that smart device makers can do before discontinuing customers’ beloved devices."
Bose released the API documentation for speakers that reached the end-of-support and updated the accompanying app to work offline. Which is great compared to other companies, but as the article says, also "is the least that smart device makers can do before discontinuing customers’ beloved devices."
"But the reality is that 75% of the people on our engineering team lost their jobs here yesterday because of the brutal impact AI has had on our business. And every second I spend trying to do fun free things for the community like this is a second I'm not spending trying to turn the business around and make sure the people who are still here are getting their paychecks every month."
Jan :rust: :ferris:
and 1 other
boosted
I've just published my new blog post:
"KDE onboarding is good now."
It will be awesome next.
I talk about my history with Linux and KDE and what I've done over the years, going through my work as a documentation contractor for KDE until I reach the current state of KDE onboarding docs.
https://rabbitictranslator.com/kde-onboarding/
#KDE #Linux #Documentation #TechnicalWriting #Cpp #CPlusPlus #Qt #QML #Python #Rust
Hover – IDE style hover documentation on any webpage
https://github.com/Sampsoon/hover
#HackerNews #Hover #IDE #Documentation #Web #Development #Tools #Documentation
I've just published my new blog post:
"KDE onboarding is good now."
It will be awesome next.
I talk about my history with Linux and KDE and what I've done over the years, going through my work as a documentation contractor for KDE until I reach the current state of KDE onboarding docs.
https://rabbitictranslator.com/kde-onboarding/
#KDE #Linux #Documentation #TechnicalWriting #Cpp #CPlusPlus #Qt #QML #Python #Rust
Stefano Marinelli
boosted
This is not the manual; man pages—https://codeberg.org/grunfink/snac2snac(1)(user manual),snac(5)(formats) andsnac(8)(administrator manual) are what you are looking for.
THIS
IS
THE
WAY
!!!
#ThisIsTheWay #SomeoneGetsIt #Documentation #snac
https://squidfunk.github.io/mkdocs-material/blog/2025/11/05/zensical/ Zensical – A modern static site generator built by the Material for MkDocs team
Yani Bellini Saibene
boosted
Day 7: roxygen2 Advanced Tags and Cross-References 📝
Master documentation with advanced roxygen2 features, with markdown-style writing! 🎯
💡 Pro Tip: Use @inheritDotParams to inherit ... parameter documentation.
📚 Resources: https://roxygen2.r-lib.org
3 media
![Cross-references: 🔗
#' @seealso [other_function()], [pkg::function()]
#' @family utility functions
#' @inheritParams parent_function](https://cdn.fosstodon.org/media_attachments/files/115/677/937/504/088/418/original/6f0a3ba8626d3b0e.png)
This is not the manual; man pages—https://codeberg.org/grunfink/snac2snac(1)(user manual),snac(5)(formats) andsnac(8)(administrator manual) are what you are looking for.
THIS
IS
THE
WAY
!!!
#ThisIsTheWay #SomeoneGetsIt #Documentation #snac
Day 7: roxygen2 Advanced Tags and Cross-References 📝
Master documentation with advanced roxygen2 features, with markdown-style writing! 🎯
💡 Pro Tip: Use @inheritDotParams to inherit ... parameter documentation.
📚 Resources: https://roxygen2.r-lib.org
3 media
Nemoudeis
boosted
Are you a Mastodonian? Do you like finding things with search engines? If so, please read my guide on Mastodon’s search, complete with visuals.
It will help you find your stuff. Find other people’s stuff. Find other people.
Search with intention. Search like a boss. I got you.
https://markwrites.io/guide-for-using-mastodon-search
New version with updates. Thanks: @stn, @katzentratschen, @DeltaWye, @ClaireFromClare, and @luca.
#Mastodon #Fediverse#FediTips #MastodonHelp #MastodonTips#Search#Help#Guide#Documentation
New #documentation: Enabling My laptop's fingerprint reader for #authentication on #linux
I found out that my work laptop has a fingerprint reader built into it (turns out the power button doubles up as a reader), so I wanted to get it set up for easy authentication on the move (it means not having to worry about CCTV catching you enter your password)
It turned out to be pretty simple, this post documents how to do so.