diataxis-documentation-framework
awesome-writing
diataxis-documentation-framework | awesome-writing | |
---|---|---|
85 | 2 | |
933 | 668 | |
1.3% | - | |
6.0 | 0.0 | |
23 days ago | over 3 years ago | |
HTML | ||
GNU General Public License v3.0 or later | The Unlicense |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
diataxis-documentation-framework
-
Breaking down common documentation mistakes
To focus your content, leverage the Diátaxis framework.
-
Understanding User Needs in Technical Writing: How Frameworks Like Diátaxis Help
Cover Image Credit: Diátaxis’ official documentation
-
Rules for Writing Software Tutorials
For that topic some nice additional stuff: https://diataxis.fr/
- Documentation chaotique ? Diataxis à la rescousse !
- Diátaxis – A systematic approach to technical documentation authoring
-
Every Board Game Rulebook Is Awful [pdf]
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.)
-
The Opposite of Documentation is Superstition (2020)
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.
- Diataxis pour organiser sa documentation
- Large language models reduce public knowledge sharing on online Q&A platforms
-
Ask HN: Technical Writing Resources
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.
awesome-writing
What are some alternatives?
arc42.org-site - (jekyll-based) website for arc42.org - the template for communicating software architectures.
documentation-framework - "The Grand Unified Theory of Documentation" (David Laing) - a popular and transformative documentation authoring framework
c4-notation - Technical resources for using the C4 model for visualizing software architecture.
awesome-gbdev - A curated list of Game Boy development resources such as tools, docs, emulators, related projects and open-source ROMs. [Moved to: https://github.com/gbdev/awesome-gbdev]
awesome-emu-resources - A curated list of emulator development resources
mark - Sync your markdown files with Confluence pages.
awesome-scalability - The Patterns of Scalable, Reliable, and Performant Large-Scale Systems
technical-writing - A collection of materials relating to technical writing
the-book-of-secret-knowledge - A collection of inspiring lists, manuals, cheatsheets, blogs, hacks, one-liners, cli/web tools and more.
pgf - A Portable Graphic Format for TeX
awesome-gbdev - A curated list of Game Boy development resources such as tools, docs, emulators, related projects and open-source ROMs.