From: garulfo@azules.eu
To: ntg-context@ntg.nl
Subject: [NTG-context] Wiki - test/proposal to further clarify documentation
Date: Sun, 14 Apr 2024 11:21:38 -0000 [thread overview]
Message-ID: <171309369853.3369328.13776426815856253767@cgl.ntg.nl> (raw)
Hi all,
I just discover the Diátaxis documentation framework :
- https://www.diataxis.fr/
- 30min video : "What nobody tells you about documentation", https://www.youtube.com/watch?v=t4vKPhjcMZg , from Daniele Procida at PyCon 2017
As I understand it, it can help both readers and writers of the documentation by clarifying the purpose of each element.
So I started a potential new "welcome page" : https://wiki.contextgarden.net/Main_Page2
The main lines would be :
- Tutorials: installation pages, step by step examples
- How-to guides: most of the existing wiki pages which are not https://wiki.contextgarden.net/Commands/ ...
- Discussions and manuals: most of the existing manuals
- Reference : the pages dedicated to commands which already include link to mailing list, stack exchange, ConTeXt's source
- https://wiki.contextgarden.net/Category:Commands
- https://wiki.contextgarden.net/Special:PrefixIndex?prefix=Command%2F
To match the logic of Diátaxis, maybe some material from command pages should be moved from "Reference" to "How-to guides",
for example, when the examples go beyond "pure description" and begin to deal with "how-to" cases, e.g. :
- Reference for setuphead: https://wiki.contextgarden.net/Command/setuphead
- How-to guides for headings: https://wiki.contextgarden.net/Titles
If it make sense, and according to your feedbacks, I can continue to reallocate existing contents.
Thanks for your feedback and thoughts.
Garulfo
___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!
maillist : ntg-context@ntg.nl / https://mailman.ntg.nl/mailman3/lists/ntg-context.ntg.nl
webpage : https://www.pragma-ade.nl / https://context.aanhet.net (mirror)
archive : https://github.com/contextgarden/context
wiki : https://wiki.contextgarden.net
___________________________________________________________________________________
next reply other threads:[~2024-04-14 11:23 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-14 11:21 garulfo [this message]
2024-04-14 14:14 ` [NTG-context] " Henning Hraban Ramm
2024-04-14 19:45 ` Peter Hopcroft via ntg-context
2024-04-16 19:07 ` Henning Hraban Ramm
2024-04-16 19:56 ` Peter Hopcroft via ntg-context
2024-04-17 6:32 ` Thomas A. Schmitz
2024-04-17 8:36 ` Hans Hagen
2024-04-17 8:47 ` Henning Hraban Ramm
2024-04-17 9:10 ` Joaquín Ataz López
2024-04-17 9:32 ` jbf
2024-04-17 11:57 ` Bruce Horrocks
2024-04-17 12:17 ` Henning Hraban Ramm
2024-04-18 12:48 ` Bruce Horrocks
2024-04-17 21:25 ` Garulfo
2024-04-18 6:32 ` Henning Hraban Ramm
2024-05-17 20:40 ` garulfo
2024-05-18 11:27 ` Bruce Horrocks
2024-05-19 12:44 ` garulfo
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=171309369853.3369328.13776426815856253767@cgl.ntg.nl \
--to=garulfo@azules.eu \
--cc=ntg-context@ntg.nl \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).