#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

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
¿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

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.

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

@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.

@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

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

https://diataxis.fr/tutorials-how-to/ #diátaxis on #tutorials vs. #HowToS

«Diátaxis insists that what matters in documentation is the needs of the user, and it’s by paying attention to this that we can correctly distinguish between tutorials and how-to guides.

Sometimes the user is at study, and sometimes the user is at work. Documentation has to serve both those needs.

A tutorial serves the needs of the user who is at study. Its obligation is to provide a successful learning experience. A how-to guide serves the needs of the user who is at work. Its obligation is to help the user accomplish a task. These are completely different needs and obligations, and they are why the distinction between tutorials and how-to guides matters: tutorials are learning-oriented, and how-to guides are task-oriented.»

What’s the difference between a tutorial and how-to guide? - Diátaxis

#TechnicalWriting #SoftwareDocumentation #Documentation #4doc #Diataxis: "4doc is much better than 5para: I’ve never read a halfway-decent 5-paragraph essay but I’ve read plenty of good 4doc pages. Even so, it still leads to the same kind of “this is the only way” thinking. People use the model even when it’s not the right choice and they don’t vary up the format even when they should.

My specific issue is that the model is not universal and it’s not comprehensive."

https://www.hillelwayne.com/post/problems-with-the-4doc-model/

My Problem With the Four-Document Model

Two universal facts about user documentation: Documentation is really important. We are really bad at writing it. We don’t have good theories on what makes for useful documentation. That is except for the four document model, or Diátaxis.1 I’m glad that people use it. I’m also a little frustrated that people use it even when its inappropriate. My problem is that it’s not a universal or comprehensive model: there’s a lot of documentation people need to write that doesn’t neatly fit the model.

Hillel Wayne