Skip to content
This repository has been archived by the owner on Jan 30, 2024. It is now read-only.

Structuring the SHACL-UI specs #3

Open
tpluscode opened this issue May 25, 2023 · 1 comment
Open

Structuring the SHACL-UI specs #3

tpluscode opened this issue May 25, 2023 · 1 comment

Comments

@tpluscode
Copy link

For a few months, I have been a mild advocate of Diátaxis. It is a set of guidelines which help write useful "documentation". TL;DR; it divided what constitutes documentation as a whole in 4 parts:

  1. Tutorials
  2. How-to guides
  3. Conceptual guides
  4. Reference guides

I find it quite useful and I may propose to aim for not just one ReSpec (side note, is bikeshed an option?) but up to four.

Specifically, a Reference guide would be more or less a vocabulary listing with ranges, domains, etc, and simple examples. Next, I would go for How-Tos to elaborate on using the spec to accomplish practical goals. Conceptual guides would also be useful, to discuss some design choices, etc. We may choose not to go for tutorials at all IMO...

@tfrancart
Copy link
Contributor

IMH experience yes, I would decouple the reference documentation, hands-on how-tos tutorial, and an architecture documentation expliciting the design choices.

@tpluscode tpluscode mentioned this issue Jun 7, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants