muki1d ago

KI generierte Dokumentation ist eine Zumutung

Ich hatte heute die Zeit mich tiefer mit zwei Projekte zu beschäftigen. Beide sind in der frühen Entstehungsphase, haben aber schon viel Dokumentation, weil es sich primär um Protokollstandards handelt. Leider ist die Dokumentation zu 99% KI generiert. Im Gegensatz zu menschlicher Dokumentation ist alles sehr redundant, sehr luftig ausgeschrieben und so, dass es gut für KI Systeme zu verdauen ist, aber nicht für Menschen. Mal geht es plötzlich sehr tief ins Detail, dann wieder nicht. […]

https://mukis.de/2026/06/03/ki-generierte-dokumentation-ist-eine-zumutung/

Greg 🌈🐻🖥️🐈May 19

Random plug for a documentation system I really enjoy and got to talk about with someone today.

If you struggle to write (or think about) good technical documentation like I do, you might benefit from learning about Diátaxis. https://diataxis.fr/

It breaks down the different reasons people go to learn and acquire information and it really helped me think about how I want to present information.

#diataxis #documentation #technicalwriting

Mail ReachMar 13
#EmailMarketers spend too much time debating what to send, but from the sender’s needs, not the reader’s.
Enter #Diataxis.
Diátaxis organises content around user intent, not format or channel. Once you look at email marketing through that lens, you realise that many email programmes fail because they deliver the wrong type of message at the wrong cognitive moment.
https://mailreach.eu/email-marketing-blog/email-marketers-marketing-diataxis-framework/?utm_medium=social&utm_source=mastodon&utm_campaign=blog
#EmailMarketing
#ContentStrategy
#ContentMarketing
#MarketingStrategy
#Marketing
#ReachRascals
Mère TeresaMar 12

Les Cast Codeurs en 2024 parlent du framework Diataxis et de ranger la documetnation

(Si vous préférez les formats audio)
https://lescastcodeurs.com/2024/12/21/lcc-320-diataxis-la-methode-de-documentation/

#documentation #diataxis

LCC 320 - Diataxis, la méthode de documentation

Emmanuel, Guillaume et Arnaud se rejoignent pour discuter de Diátaxis une approche pour structurer sa documentation. Ils offrent leur perspective sur leur usage et leur compréhension. Le sujet s’ouvre ensuite pour discuter des plateformes de documentation et comment l’IA impacte la documentation. Cet épisode est aussi sorti en vidéo, n’hésitez pas nous dire ce que vous en pensez des retours et souscrivez au channel YouTube 🤗.

Les Cast Codeurs Podcast
Tarsis.netJan 13
¿Necesitas crear o racionalizar documentación en tu empresa? Hardware, software, sistemas, procedimientos... No lo hagas a ciegas. Ayúdate de un framework adecuado y alíate con los mejores. Te contamos cómo hacerlo en nuestro último artículo del blog.
https://www.tarsis.net/blog/importancia-para-empresas-buena-documentacion-diataxis/?utm_medium=social&utm_source=mastodon&utm_campaign=documentacion
#Diátaxis #documentación #documentation #tutorials #tutoriales #howto #howtos #docs
xyhhx 🔻Aug 28, 2025

found a very interesting framework for writing effective documentation: https://diataxis.fr

#documentation #diataxis #docs

Diátaxis

Diátaxis is a widely-adopted, pragmatic and systematic approach to thinking about and creating documentation.

Alexandre B A Villares 🐍Aug 24, 2025

#Diátaxis and #Python #documentation

https://discuss.python.org/t/diataxis-and-python-documentation/41836

Diátaxis and Python documentation

I’d like to put forward a vision for the future of Python’s documentation, as published at https://docs.python.org, in the hope of building general consensus for two things: an idea of what good means in documentation and its application to Python’s documentation in particular ways of working that will bring about significant improvements more swiftly I see a very strong opportunity to bring what I can do, to what I think Python’s documentation needs, and I would like to do more of that work ...

Discussions on Python.org
Colan SchwartzOct 28, 2024

@echerng How about a #startup providing a #saas product that gets access to all of the company accounts where relevant information is stored, and then uses #ai to keep #documentation up-to-date for #businesscontinuity?

It could even provide it in a standard format, like #diataxis: https://diataxis.fr/

I'm open to talking about this if anyone out there is interested.

#startups #idea #ideas #startupideas

Diátaxis

Diátaxis is a widely-adopted, pragmatic and systematic approach to thinking about and creating documentation.

Show threadDavid ZaslavskyJul 20, 2024

@kevinbowen Oh this is interesting. I've kept this (ish) as one of my personal principles for writing documentation, that there need to be different kinds of documentation to serve different audiences (especially: tutorial and reference docs), but I never knew there was a formal system for it.

#documentation #Python #Diataxis

Kevin Bowen (has moved) Jul 20, 2024

While I haven't necessarily drank the #Diataxis #documentation kool-aid 😄 , I do think that what is going on with the #Python documentation is interesting and it is a conversation and a mind-set that it worthy of consideration & attention. YMMV

https://discuss.python.org/t/diataxis-and-python-documentation/41836

Diátaxis and Python documentation

I’d like to put forward a vision for the future of Python’s documentation, as published at https://docs.python.org, in the hope of building general consensus for two things: an idea of what good means in documentation and its application to Python’s documentation in particular ways of working that will bring about significant improvements more swiftly I see a very strong opportunity to bring what I can do, to what I think Python’s documentation needs, and I would like to do more of that work ...

Discussions on Python.org