report #9378
Updated by Andreas Kohlbecker about 3 years ago
WebEx Meeting: https://fu-berlin.webex.com/fu-berlin/j.php?MTID=ma3d5a3cfabd30fbfdccb11e37122a1e4
## Teilnehmer:
* Anton Güntsch
* Andreas Kohlbecker
* Andreas Müller
* Katja Luther
* Walter Berendsohn
## Thema
Besprochen werden sollen Fragen zur Dokumentation der EDIT Plattform, die sich vornehmlich an Nutzer richtet, im Gegensatz zu Dokumentation die sich **ausschließlich** an Entwickler richtet.
* Wo soll die Dokumentation veröffentlicht, bereitgestellt werden und in welchen Formaten?
* Brauchen wir eine In-App Dokumentation im Taxeditor?
* Modularisierung der Dokumentation? (Allgemeine Doku vs Workshopanleitungen)
* Workflow und Tools
## Ausgangslage:
### Zielgruppen für Dokumentation:
* "End-Nutzer"
* Taxonomist
* Teachers
* Postgraduates
* Students
* Assistants
* Project Admins
* Developers
* Decision makers (technical)
* IT-Satff (--> System Requirements)
### Bestehende Dokumentation:
* `//bgbmc2.bgbm.fu-berlin.de/Gruppen/BDI/EDIT-Plattform/_Latest Versions/User Manual`
* als Word-Datei
* Automatische Konvertierung der Word-Dokumente in PDFs
* Bereitstellung im developer wiki: [PlatformDocumentation](https://dev.e-taxonomy.eu/redmine/projects/edit/wiki/PlatformDocumentation)
* *Zielgruppen*:
* Taxeditor "site-doc" edit:source:taxeditor|src/site
* maven site doc: XML + APT files
* Kompilierung im durch maven im Release-Prozess als Website
* Veröffentlichung unter https://cybertaxonomy.eu/taxeditor/
* *Zielgruppen*:
* Taxeditor "in-app help" edit:source:taxeditor|eu.etaxonomy.taxeditor.help (see also [#8555 Eclipse-Help-System-InfoCenter](redmine/issues/8555#Eclipse-Help-System-InfoCenter))
* HTML & XML files
* *Zielgruppen*:
* Installationsanleitungen in der cybertaxonomy.eu Drupal-Site
* [server_requirements](https://cybertaxonomy.eu/setups/group/server_requirements)
* [server_installation](https://cybertaxonomy.eu/setups/group/server_installation)
* [taxeditor_installation](https://cybertaxonomy.eu/tax_editor/installation) [tax_editor_installation](https://cybertaxonomy.eu/tax_editor/installation) --> verweist auf Manual-EDIT-Platform-01-INSTALL.pdf
* [taxeditor_connection](https://cybertaxonomy.eu/setups/group/taxeditor_connection)
* [dataportal_requirements](https://cybertaxonomy.eu/setups/group/dataportal_requirements)
* [dataportal_installation](https://cybertaxonomy.eu/setups/group/dataportal_installation)
* spezielle "Entwickler-Dokumentation" (hier nur der Vollständigkeit wegen , aufgeführt)
* [[edit:CdmLibraryDev]]
* Hier auch [[edit:CdmAuthorisationAndAccessControl| Access Control, Roles, Groups]] --> *Zielgruppen*: Entwickler, **Project Admins**
* diverse Files im Code?
* java-doc im Code
### Probleme derzeit:
* Dokumentation an verschiedenen Stellen verteilt.
* Worddoc/PDFs: Vermischung von allgemeiner Dokumentation zum Taxeditor und sehr spezifischer Workshopanleitungen --> Redundanz --> Modularisierung möglich?
* Sharing und Synchronisierung über NT-Shares
* unter Linux: häufig NT_STATUS_ACCOUNT_LOCKED_OUT, nach Synchronisierung offline gehen --> Mülleimer blockiert, Setup kompliziert und fehleranfällig,
* allgemein:
* Handling von Synchonisierierungsproblemen intransparent
* keine implizite Versionierung
* Trennung von Dokumentation und Code.