diataxis-documentation-framework VS technical-writing

Perhaps it could be restructured to separate out the howto from the explanation to serve the reader’s intended use at the time as described here: https://diataxis.fr

Create an organized repository for regularly updated documentation, making it easy to access important information.

Such integration capabilities really help push the developer productivity, whether that's in single-project workspaces or monorepos. Juri also dives deeper into efforts from the team to provide high quality educational content around Nx and its capabilities. The Nx docs have been restructured to follow the Diataxisframework, dividing content into into learning-, task-, understanding- and information-oriented sections.

I think people may be missing the core point of this article.

Anton has built a new thing, https://codapi.org/ - which provides a web component that makes it easy to embed interactive code snippets for HTTP APIs, Python code and more directly in pages of documentation.

This article demonstrates this new technology in the context of the https://diataxis.fr/ documentation framework, which recommends going beyond just straight API reference documentation and ensuring you cover tutorials, how-to guides and explanations as well.

I think this is really cool.

As much as possible on all facets, because that is what "documentation" means, and if you are a product manager who wasn't paying attention in product management 101 and need some guidance on what "documentation" is, try reading this first.

Related: Diátaxis - A systematic framework for technical documentation authoring [1]

"The Diátaxis framework aims to solve the problem of structure in technical documentation. It adopts a systematic approach to understanding the needs of documentation users in their cycle of interaction with a product.

Diátaxis identifies four modes of documentation - tutorials, how-to guides, technical reference and explanation. It derives its structure from the relationship between them.(...)"

[1] https://diataxis.fr/

the divio style docs concept got further refined by the creator with this - https://diataxis.fr/

mostly the same but some additional information for people who are interested

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