diataxis-documentation-framework VS technical-writing

To focus your content, leverage the Diátaxis framework.

Cover Image Credit: Diátaxis’ official documentation

For that topic some nice additional stuff: https://diataxis.fr/

I'm a little less than impressed by the presentation here. The idea that Divio is describing here is the Diataxis framework (https://diataxis.fr/), which "is the work of" (https://diataxis.fr/colophon/) Daniele Procida (https://vurt.eu/). Who, incidentally, is also giving the PyCon talk in the video on the page you linked (https://www.youtube.com/watch?v=t4vKPhjcMZg). But I don't see anything resembling attribution for the ideas. They aren't just common industry knowledge or "received wisdom". (And the "quote" from David Laing at the top isn't really accomplishing anything, either.)

Both is important. And related. Documentation needs to be discoverable. I was amazed when I tried jj (jujutsu, the "new git") and it popped me into some kind of weird textual user interface after executing `jj split` and I felt lost. I guessed, pressing `?` won't hurt and it told me just to use the mouse. The menues showed the related hot keys.

But the actual documentation of the tool has room for improvement. I needed a YouTube video to get started and that's rare for me.

So what I want to say is, that you need an intuitive, discoverable UI, but also a documentation that has each case (and if it's just for linking in 1st level support cases) _and_ is discoverable. And by that I mean both easy to grasp (e.g. following https://diataxis.fr/) and also can actually be found. I've had cases where a tool had good documentation, but actually finding it was the hard part.

I've found https://diataxis.fr/ to be an excellent framework on which to hang documentation efforts. It helps you to understand what kinds of documentation resources help users most.

a few people mentioned technical writing so I will also just plug my repo quickly which has my favourite resources to learn more about tech writing and also a list of companies that pay for it (often per article so very flexible).

https://github.com/sixhobbits/technical-writing

Have you considered technical writing? I don't have experience with chronic pain but if you can still comfortably play video games maybe you can also write articles?

I used to do this as a side gig and collected some resources and places that pay here [0]

I have since started a technical publishing company [1] so it's a full time focus and most of our writers work 20h/week or less. Feel free to apply if it sounds interesting.

[0] https://github.com/sixhobbits/technical-writing

[1] https://ritza.co

We are running a course for exactly this! [0] Technically applications closed already but we will likely have some more space, or we will run another cohort soon so feel free email me and I will try fit you in.

I also keep a repository of my favourite books and some other resources here [1]

And some very short advice we give to our writers here [2]

[0] https://styleguide.ritza.co/writing-course/

[1] https://github.com/sixhobbits/technical-writing

[2] https://ritza.co/handbook/improving-your-writing/how-do-I-be...