Fabians Bookmarks
  • Fabians Bookmarks
  • Tag cloud
  • Daily
  • RSS Feed
  • Login
Delete   Set public   Set private   Add tags   Delete tags
  Add tag   Cancel
  Delete tag   Cancel
17523 shaares · 14139 private links
Filters
Links per page
20 50 100
4 results tagged docs

Diátaxis – A systematic approach to technical documentation authoring

Diátaxis identifies four distinct needs, and four corresponding forms of documentation - tutorials, how-to guides, technical reference and explanation. It places them in a systematic relationship, and proposes that documentation should itself be organised around the structures of those needs.

documentation writing technicalwriting docs
December 11, 2025 at 14:14:40 GMT+1*
https://diataxis.fr/

MyST - Markedly Structured Text

MyST allows you to write Sphinx documentation entirely in markdown. MyST markdown provides a markdown equivalent of the reStructuredText syntax, meaning that you can do anything in MyST that you can do with reStructuredText. It is an attempt to have the best of both worlds: the flexibility and extensibility of Sphinx with the simplicity and readability of Markdown.

documentation markdown python sphinx docs commonmark
December 10, 2020 at 14:43:59 GMT+1
https://myst-parser.readthedocs.io/en/latest/

rust-lang-nursery/mdBook: Create book from markdown files. Like Gitbook but implemented in Rust

book markdown gitbook docs rust
March 20, 2019 at 12:02:57 GMT+1
https://github.com/rust-lang-nursery/mdBook

Writing good documentation

python documentation programming softwareengineering docs
November 12, 2009 at 13:54:10 GMT+1
http://jacobian.org/writing/good-documentation/
Filters
Links per page
20 50 100
By @fabian@floss.social · Powered by Shaarli
Fold Fold all Expand Expand all Are you sure you want to delete this link? Are you sure you want to delete this tag? The personal, minimalist, super-fast, database free, bookmarking service by the Shaarli community