diataxis-documentation-framework VS diagrams

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

diagrams - Diagram as Code.

Mingrammer is an intriguing tool for individuals who prefer coding diagrams rather than creating them through graphical interfaces. It operates using Python code and offers a relatively quick setup process. It is compatible with AWS, Azure, GCP, Alibaba, and Oracle. Notably, the project is open source and has garnered significant attention on GitHub with over 31K stars.

Ja sam koristio ovo: https://diagrams.mingrammer.com/

That’s another option: https://diagrams.mingrammer.com Guessing with IaC done with Pulumi (Python) and this, it could pretty powerful and automatically generated.

Diagrams allow you to draw cloud system architectures using Python code.

I use excalidraw a lot for short conversations. If I have to go into major detail I use diagrams https://diagrams.mingrammer.com