#diataxis — Public Fediverse posts

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

#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

#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

#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

#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

#Diátaxis and #Python #documentation

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

@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

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

#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/

Sarah Haïm-Lubczanski: Présentation:
Améliorons ensemble la documentation de #PostgreSQL ! avec Sarah Haïm-Lubczanski

#postgres #diataxis #postgresqlfr #pgdayfr

Sarah Haïm-Lubczanski: Présentation:
Améliorons ensemble la documentation de #PostgreSQL ! avec Sarah Haïm-Lubczanski

#postgres #diataxis #postgresqlfr #pgdayfr

Sarah Haïm-Lubczanski: Présentation:
Améliorons ensemble la documentation de #PostgreSQL ! avec Sarah Haïm-Lubczanski

#postgres #diataxis #postgresqlfr #pgdayfr

Sarah Haïm-Lubczanski: Présentation:
Améliorons ensemble la documentation de #PostgreSQL ! avec Sarah Haïm-Lubczanski

#postgres #diataxis #postgresqlfr #pgdayfr

Sarah Haïm-Lubczanski: Présentation:
Améliorons ensemble la documentation de #PostgreSQL ! avec Sarah Haïm-Lubczanski

#postgres #diataxis #postgresqlfr #pgdayfr

Discovered @EvilDMP's Diátaxis documentation framework this morning, as I plan a migration of my #DTAT 'lay outreach' blog from #WordPress to #Quarto. It shows me how little my previous #SciComm efforts have ventured outside the #explanation quadrant! Has anyone else on here adopted #diataxis for #SciComm around a #methodology?
https://diataxis.fr/

#docs #diataxis #man

Иногда проекту достаточно Readme или man. Но у https://docs.selfprivacy.org другой масштаб. Надо не только показать как продуктом правильно пользоваться, но и обучить пользователя приватному поведению. Объем работы удручает, но выход есть — https://diataxis.fr Популярный фреймворк, который помог организовать документацию для многих компаний, включая Cloud Flare. Коротко: https://github.com/evildmp/diataxis-documentation-framework/blob/main/how-to-use-diataxis.rst
Писать документацию всё равно придёться, но уже с понятными целями и задачами.

@liw Not sure if it's missing tutorials or just mixing tutorials with explanations.

Certainly has no reference material, I assume that's in a manual page?

#diataxis