Sonar helps you commit clean code every time. With over 225 unique rules to find Python bugs, code smells & vulnerabilities, Sonar finds the issues while you focus on the work. Learn more →
Diataxis-documentation-framework Alternatives
Similar projects and alternatives to diataxis-documentation-framework
-
diataxis-documentation-framework
"The Grand Unified Theory of Documentation" (David Laing) - a popular and transformative documentation authoring framework
-
-
InfluxDB
Access the most powerful time series database as a service. Ingest, store, & analyze all types of time series data in a fully-managed, purpose-built database. Keep data forever with low-cost storage and superior data compression.
-
-
diagrams
:art: Diagram as Code for prototyping cloud system architectures
-
redux-toolkit
The official, opinionated, batteries-included toolset for efficient Redux development
-
fastapi
FastAPI framework, high performance, easy to learn, fast to code, ready for production
-
-
Sonar
Write Clean Python Code. Always.. Sonar helps you commit clean code every time. With over 225 unique rules to find Python bugs, code smells & vulnerabilities, Sonar finds the issues while you focus on the work.
-
-
xournalpp
Xournal++ is a handwriting notetaking software with PDF annotation support. Written in C++ with GTK3, supporting Linux (e.g. Ubuntu, Debian, Arch, SUSE), macOS and Windows 10. Supports pen input from devices such as Wacom Tablets.
-
xstate
State machines and statecharts for the modern web.
-
aedis
An async redis client designed for performance and scalability [Moved to: https://github.com/boostorg/redis]
-
verifica
Verifica is Ruby's most scalable authorization solution
-
-
Infosec_Reference
An Information Security Reference That Doesn't Suck; https://rmusser.net/git/admin-2/Infosec_Reference for non-MS Git hosted version.
-
clojure-style-guide
A community coding style guide for the Clojure programming language
-
flame
Flame is self-hosted startpage for your server. Easily manage your apps and bookmarks with built-in editors. (by pawelmalak)
-
awesome-writing
An awesome list of information to help developers write better, kinder, more helpful documentation and learning materials
-
Ark
ArkScript is a small, fast, functional and scripting language for C++ projects
-
redux-essentials-example-app
Example app for the Redux Essentials tutorial
-
redux-xstate-poc
Manage your Redux side effects with XState. Use 100% of XState's features.
-
SaaSHub
SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives
NOTE:
The number of mentions on this list indicates mentions on common posts plus user suggested alternatives.
Hence, a higher number means a better diataxis-documentation-framework alternative or higher similarity.
diataxis-documentation-framework reviews and mentions
Posts with mentions or reviews of diataxis-documentation-framework.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2023-05-14.
-
JavaScript State Machines and Statecharts
Hi, I maintain Redux and wrote most of our docs (including our current tutorials).
Can you give some details on which parts of our docs you feel are "incomprehensible"? I'm curious which specific pages you've been looking at, and for what purpose.
We've tried to organize the docs using the "Documentation System" approach described at [0]: Tutorials for teaching step-by-step, Explanations and How-To guides for specific topics, and References for API details.
Generally we want people to go through our "Redux Essentials" tutorial [1] as the primary way to learn how to use Redux correctly. It teaches "modern Redux" patterns with Redux Toolkit as the standard way to write Redux logic (including RTK Query for handling data fetching), and React-Redux hooks in components.
I'm genuinely interested in feedback on what explanations aren't clear and how we can improve things!
[0] https://documentation.divio.com/
[1] https://redux.js.org/tutorials/essentials/part-1-overview-co...
-
Dealing with documentation
Read the Docs offers free hosting of Sphinx-based documentation. I recommend setting up a basic documentation very early so that you can easily add material when you have something to write about. I also recommend studying The Grand Unified Theory of Documentation, but don't overthink it.
-
AMA this Friday with Technical Writer Alan Mach!
Of course you can! I don't have an English degree, but I assume being an English major you can write well. Just remember, as a Technical Writer, your writing needs to be in plain English. I would prioritize building a portfolio of writing samples to show you understand documentation. Take a look at Divio's explanation of the different types of documentation. If you create 3-4 pieces (in total) of how-to guides, knowledge articles, and tutorials, you should be ahead of others with random writing pieces. https://documentation.divio.com/
You have some knowledge since you've done a few aspects of Technical Writing so maybe brush up on the different types of documentation. https://documentation.divio.com/. Take a look at Amruta's process on writing a Technical Document. https://www.youtube.com/playlist?list=PLoynTxuTLXaBs05-A4rlEC9ijs9ZzSxRP. Then look at some products/tools you're interested in or in your industry and write three documentation samples. A mix of tutorials, how-to, and explanation guides would be a great start. I took an online course, which helped me create three portfolio pieces with instructor feedback. I don't want to break any rules sharing it here but feel free to DM me.
-
Verifica, a new gem to handle authorization at scale
It sounds like you might benefit from adopting a framework like https://documentation.divio.com to add structure and focus to your documentation.
-
Is it just me or is the quality of the Boost API docs just.. kind of terrible? Like compare it to cppreference (very good) or Qt docs (also great).
Bringing newcomers up to speed is not the purpose of a reference, though. For that, a different kind of documentation is needed. This site gives a good overview over which kind of documentation is a good fit for which purpose: https://documentation.divio.com/
- How to improve documentation / technical writing skills?
-
How to learn Clojure idioms?
Thank you, Sean. I came across https://clojure.org/reference/transducers, but if falls mostly in the "Explanation" category of documentation.
-
Systemd.timer, an Alternative to Cron
Documentation and Systemd will remain a weird disconnect.
until it address the 4-ways Divio documentation methods.
- A systematic framework for technical documentation authoring
-
A note from our sponsor - Sonar
www.sonarsource.com | 3 Jun 2023
Stats
Basic diataxis-documentation-framework repo stats
41
74
0.0
2 months ago
The primary programming language of diataxis-documentation-framework is Python.
Popular Comparisons
- diataxis-documentation-framework VS diataxis-documentation-framework
- diataxis-documentation-framework VS pgf
- diataxis-documentation-framework VS diagrams
- diataxis-documentation-framework VS redux
- diataxis-documentation-framework VS fastapi
- diataxis-documentation-framework VS redux-toolkit
- diataxis-documentation-framework VS SQLite
- diataxis-documentation-framework VS systemd
- diataxis-documentation-framework VS xournalpp
- diataxis-documentation-framework VS mkdocs-material
SaaSHub - Software Alternatives and Reviews
SaaSHub helps you find the best software and product alternatives
www.saashub.com