Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[IDEA, EXTERNAL RESOURCE] Categorise education content into document types #35

Open
Different2day opened this issue Nov 16, 2024 · 0 comments

Comments

@Different2day
Copy link

Different2day commented Nov 16, 2024

@kakinney, @brianelton

  1. I wonder whether it would be helpful to check out the document types in the Diátaxis framework. The latter are:
  • tutorials
  • how-to guides
  • technical reference
  • explanation

We could

  • perhaps compare the document types on WAI with the Diátaxis doc types, and maybe categorise them into those groups
  • categorise educational material for young coders

External resource: https://diataxis.fr/

I'm aware that you and most in the group are seasoned educators and authors.
Am sharing this simple technical documentation framework just in case it's in any way useful.

Complex hierarchies are mentioned at https://diataxis.fr/complex-hierarchies/.
The challenge looks familiar.

For context: this is where I came across the resource https://oboacademy.github.io/obook/.

  1. Separate question: would you like us to add ideas and resource suggestions to an earlier github issue, or open a new one?

I opened a new one because this may be interesting for either project.
Also thought that smaller less-aggregated issues are perhaps easier to manage for you.

What works best for you?

Anya

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant