Re:Diátaxis – A systematic approach to technical documentati...
by _acco on Thursday December 05, 2024 @11:10AM
(#42329470)
Aye, thanks! That's very helpful to hear. I just cut back our use of the acronym a ton:
https://github.com/sequinstream/sequin/commit/28bfba603da6d2...
Re:Diátaxis – A systematic approach to technical documentati...
by mdaniel on Thursday December 05, 2024 @12:45PM
(#42330468)
In case you weren't already aware, most markdown parsers support actual HTML tags in it, and there's <abbr title="change data capture">CDC</abbr> that allows being visually succinct, is a11y friendly, and in most browsers is visually distinct to prompt the user there's more content hidden in the hover or long-press
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ab...
I'm also aware of https://developer.mozilla.org/en-US/docs/Web/HTML/Element/df... but I think it has more nuance to it and for sure involves having a lot more supporting structure in the document
Re:Diátaxis – A systematic approach to technical documentati...
by _acco on Thursday December 05, 2024 @01:14PM
(#42330789)
Very fun – I wasn't aware, thank you!
Re:Diátaxis – A systematic approach to technical documentati...
by eightnoneone on Thursday December 05, 2024 @03:18PM
(#42332279)
You were _this_ close!
What’s a CDC?
Minor note: The only thing in your docs that made me pause was the repeated use of "CDC", which I had to google the definition of. (For context, I have implemented "CDC" several times in my career, but wasn't familiar with the acronym)