Documentation Concept #580
Replies: 3 comments 3 replies
-
Presentation of the DocumentationTemplate for htmldocsy is probably our best option. Templates für Issues und PRs inside of GitHubGitHub Templates to structure the interaction with the OpenSource community. |
Beta Was this translation helpful? Give feedback.
-
How we want to start improving the docsFirst target group: "Technical Users" General:
Structure specific:
Regarding Features and extensions:
Who works on which:
|
Beta Was this translation helpful? Give feedback.
-
Hi all, while I was cleaning up the repo regarding milestones and projects, I stumbled across a few (closed) issues where Jim explains processes and implementations, some of them quite detailed. Maybe some of the content will help to avoid having to start from scratch.
|
Beta Was this translation helpful? Give feedback.
-
We talked in a smaller group about how we can improve the documentation and made some notes.
Please review them and add comments if you like! Please also add comments if something is missing in the structure below!
Target Groups
We identified two main groups of people who would benefit from a good documentation:
We write technical users in quotes because the name is not the best. It was chosen to clarify that e.g. managers are out of scope. For them, the general data space information in Gaia-X/Catena-X and on the Internet should be a better help.
Usage cases
We first tried to identify the use cases of the target groups in order to later create the structure of the documentation based on this.
Generell use-cases are:
Technical User
Additional to the general use-cases the technical user could also be interested in the following:
Contributor/Developer of the EDC and the extensions
Presentation
We have also discussed how the documentation should be presented. We currently have two main options that can be implemented with little or no effort:
gh-pages
)For now, we would stay with the current process to avoid additional overhead.
Structure
This is a draft of the structure and topics we would like to present in the documentation:
In our eyes, the bold topics are either already documented and would only need to be revised, are quickly created, or could important for the first draft.
Some Notes:
docs/ids/README.md
Next steps
Edits:
docs/ids/README.md
Beta Was this translation helpful? Give feedback.
All reactions