Project

General

Profile

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 
 *  Entwickler 
 * Entscheider 
 *  IT-Abteilung und -Support (--> System Requirements, Troubleshooting) - Informationen zu Voraussetzungen einer Installation und Tips zur Vor-Ort-Hilfe ohne das das EDIT-Team gebraucht wird. 
 * ➃ Entwickler 

 ### 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*:  End-Nutzer 
 * 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/ 
     * Seiten für Endnutzer    ➽ *Zielgruppen*: ❶ End-Nutzer 
           
          * Overview - komplett veraltet 
          * Screenshots - leer  
          * Manual - Link zu    [PlatformDocumentation](https://dev.e-taxonomy.eu/redmine/projects/edit/wiki/PlatformDocumentation) 
     * Seiten für Entwickler ➽ *Zielgruppen*: ➃ Entwickler, (❸ IT-Staff) 
          * Getting Started = "Setting up a Taxonomic Editor development environment" --> Überlappung mit [[edit:TaxonomicEditorDevelopmentEnvironment| wiki TaxonomicEditorDevelopmentEnvironment]] und #4227 
          * Troubleshooting --> Hier auch informationen die sich eigentlich an andere ➽ *Zielgruppen* richten:  End-Nutzer,  IT-Staff 
     * ➽ *Zielgruppen*: Entwickler, (IT-Staff) 
 * 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*:  End-Nutzer 
 * Installationsanleitungen in der cybertaxonomy.eu Drupal-Site ➽ *Zielgruppen*:  End-Nutzer, ❷ Entscheider, ❸ IT-Staff, Entscheider 
     * [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) --> 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,  End-Nutzer 
     * diverse Files im Code? 
     * java-doc im Code 

 ### Probleme derzeit: 

 * Dokumentation an verschiedenen Stellen verteilt. 
 * Trennung von Dokumentation und Code. 
 * Worddoc/PDFs: Vermischung von allgemeiner Dokumentation zum Taxeditor und sehr spezifischer Workshopanleitungen --> Redundanz --> Modularisierung möglich?   
 * Sharing und Synchronisierung über NT-Shares 
     * Handling von Synchonisierierungsproblemen intransparent 
     * keine implizite Versionierung 
     * unter Linux: häufig NT_STATUS_ACCOUNT_LOCKED_OUT, nach Synchronisierung offline gehen --> Mülleimer blockiert, Setup kompliziert und fehleranfällig,  
    
       

Back