stepci VS diataxis-documentation-framework

Location: EU, Germany

Remote: Yes

Willing to relocate: Yes

Technologies: HTML, CSS, TailwindCSS, JavaScript, TypeScript, Node.js, React/Next.js, Vue/Nuxt, GraphQL, REST, Postgres, Git, AWS, Docker + K8s

GitHub: https://github.com/mishushakov

LinkedIn: https://linkedin.com/in/mishushakov

Email: hey at mish.co

Most recently, I worked at Step CI a Technical Founder and authored the API-Testing Framework (https://stepci.com) and Garph (https://garph.dev), a full-stack API-Framework, which brings the developer-experience of tRPC to GraphQL.

My passion is in making tools developers love using and make them more productive.

For automated testing, you should give Step CI (https://github.com/stepci/stepci) a try

Ps. I helped build it

The problem is that you can import commonjs modules in ESM but not the other way around. For stepci (https://stepci.com) we have chosen to not support ESM for this very reason. We want that the library “just works” for all our users

Hopscotch is not a Postman fork as far as I know.

You can also do request chaining with Step CI (https://stepci.com) and Hurl (https://hurl.dev)

There’s also Step CI: https://stepci.com

Disclaimer: I’m one of the authors

It's a config driven uptime monitoring service powered by Step CI, an open source API testing framework.

You might try DiY-ing it with this open-source framework - https://stepci.com/

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