TIBHannover / semantic-glossar

CPS: Semantic glossary creation pipeline
https://tibhannover.github.io/semantic-glossar/
MIT License
1 stars 5 forks source link

User Quick Start Guide: Glossary Form & System #17

Open mrchristian opened 4 months ago

mrchristian commented 4 months ago

The Quick Start Guide is intended as a one pager print out for the August 2024 Co-Site Book Sprint. We can have additional information online and ticketted support - chat.

Technical writing method: Diátaxis - https://diataxis.fr/ - here use the tutorial style where the target audience has no working knowledge of process and needs tutoring.

Guide will be: German and English.

The one page quick start guide needs to cover:

  1. Overview (end-to-end): Likely a diagram
  2. Create term
  3. Lookup term
  4. Edit term
  5. Full list of terms
  6. Inner working and future use cases: A. Glossary management B. Automatic Glossary Indexing of user authored publication. C. Semi-Automated Literature Review

Document for authoring is here:

EN - https://write.handbuch.io/document/855

DE - https://write.handbuch.io/document/856

The results will be published as part of CPS Guide here:

https://nfdi4culture.gitlab.io/ta4-data-publication-and-availability/cps-documentation/

mrchristian commented 4 months ago

One pager guide EN outputted from Fidus to Google Drive - https://docs.google.com/document/d/1GNeyOgeq_3bxWhnFNs9ayJFNg5uffCmrFy0tPzNBY-s/edit?usp=sharing