[Kitodo] Kitodo Dokumentation Wunschliste

Mi Mai 10 08:54:03 CEST 2017

Lieber Stefan,

ich würde noch hinzufügen, dass wir uns über den Ort einer solchen Dokumentation nochmal Gedanken machen sollten. Die GitHub-Wikis sind meines Erachtens funktional zu beschränkt, um darin umfangreichere und stark strukturierte Dokumentationen abzulegen.
Mein Vorschlag wäre daher, dass wir wie folgt verfahren:

- Die Dokumentation zu Kitodo.Production (technisch wie auch perspektivisch die Anwenderdokumentation) kommt auf ReadTheDocs und wird über das kitodo-production-Repo gepflegt. Daran arbeiten die Kollegen von der HU Berlin im Rahmen des DFG-Projekts bereits.

- Die Dokumentation zu Kitodo.Presentation sollte gemäß TYPO3 Coding Guidelines im ReST-Format gefüllt werden, damit sie im TER darstellbar ist. Aus GitHub heraus würde ich dann dorthin verweisen. Das Grundgerüst haben wir ja schon, die Inhalte fehlen aber leider noch.

- Für jegliche andere Dokumentation (allgemeine Best Practice-Tipps, etc.) bräuchten wir noch eine geeignete Plattform. Wir könnten dafür ein eigenes Repo aufsetzen und wieder mit ReadTheDocs, GitHub-Pages o.ä. arbeiten. Oder wir könnten das als Teil von kitodo.org in TYPO3 pflegen. Mir ist es letztlich gleich. Als Release Management unterstützen wir gerne die Bereitstellung der technischen Plattform (Einrichtung eines Repos, Zugriffsrechte in TYPO3, etc.), würden uns aber freuen, wenn sich andere Mitglieder der Community um die Inhalte verdient machen würden.

Viele Grüße
Sebastian

-- 
Sebastian Meyer
Stabsstelle Digitale Bibliothek 

Sächsische Landesbibliothek -
Staats- und Universitätsbibliothek Dresden (SLUB)
Abteilung IT, Referat Digitale Bibliothek
01054 Dresden
Besucheradresse: Zellescher Weg 18
Tel.: +49 351 4677 206 | Fax: +49 351 4677 711
Mobil: +49 173 9615528
E-Mail:  sebastian.meyer at slub-dresden.de

http://www.slub-dresden.de

> -----Original Message-----
> From: kitodo-community-bounces at kitodo.org [mailto:kitodo-
> community-bounces at kitodo.org] On Behalf Of Alexander Bigga
> Sent: Monday, May 08, 2017 8:10 PM
> To: kitodo-community at kitodo.org
> Subject: Re: [Kitodo] Kitodo Dokumentation Wunschliste
> 
> Lieber Herr Weil,
> 
> Sie haben völlig recht, dass die Dokumentation verbessert werden kann.
> Kitodo.Production ist ja mittlerweile mit seinem Wiki schon recht
> vorbildlich.
> 
> Bei Kitodo.Presentation sieht es nicht ganz so vorbildlich aus. Als
> TYPO3-Extension sollte die Dokumentation gemäß Konvention zunächst
> in
> Englisch erfolgen und dann auf Deutsch übersetzt werden. Das ist zwar
> angelegt im Ordner Documentation/ und wird im TER (TYPO3 Extension
> Repository) auch korrekt gerendert [1]. Allein, es fehlen die Inhalte,
> weil die Einstiegshürde für das ReST-Format doch gefühlt hoch ist.
> 
> Auch wenn diesen offiziellen TYPO3-Weg relativ steinig ist, würde ich
> Ihn doch befürworten und dann im Kitodo.Production Wiki darauf
> verweisen.
> 
> Nur, wer fängt an? Merge-Request nehmen wir natürlich gerne an.
> 
> Viele Grüße
> 
> Alexander Bigga
> 
> [1] https://docs.typo3.org/typo3cms/extensions/dlf/Index.html
> 
> Am 08.05.2017 um 16:41 schrieb Anzenhofer Thomas:
> > Sehr geehrter Herr Weil,
> >
> > ich würde Ihre Frage uneingeschränkt bejahen. Immer mehr
> Bibliotheken richten Digitalisierungsgeschäftsgänge ein, und selbst
> spezialisierte Kollegen wissen nicht alles - und das, was man weiß, hat
> man auch nicht jederzeit parat. Deshalb, und weil sich die verfügbaren,
> für dieses Feld relevanten Informationen auf zahllose digitale oder
> gedruckte Ressourcen verteilen, wäre so etwas wie eine zentrale
> "Sammelstelle" keine schlechte Idee. Eine offene Wissensressource,
> insbesondere ein Wiki, wäre zudem keine schlechte Ergänzung zu einer
> quelloffenen, Community-basierten Anwendung.
> >
> > Obwohl eine Mailingliste wie diese keine optimale Ressource zum
> Nachschlagen ist, habe ich schon mehrfach gesehen, wie hilfreich
> Kollegen bei einer Anfrage hier sind. Die Nutzer von Kitodo wären sicher
> ausreichend motiviert, um eine besser strukturierte Wissensressource
> über längere Zeit zu pflegen, und würden hier allein schon aus
> beruflichen Gründen länger aktiv bleiben. Das wären gute
> Voraussetzungen.
> >
> > Meine fünf Cent; und herzliche Grüße an Sie und an alle Kolleginnen
> und Kollegen!
> >
> > Thomas Anzenhofer
> > _______________________________
> >
> > Thomas Anzenhofer
> > Universität der Bundeswehr München
> > Universitätsbibliothek
> > Dezernat Benutzung und Digitale Dienste
> > Werner-Heisenberg-Weg 39
> > 85577 Neubiberg
> > Telefon: 089-6004-3337
> > Mail: thomas.anzenhofer at unibw.de
> > Internet: www.unibw.de/unibib
> >
> >
> >
> > -----Ursprüngliche Nachricht-----
> > Von: kitodo-community-bounces at kitodo.org [mailto:kitodo-
> community-bounces at kitodo.org] Im Auftrag von Stefan Weil
> > Gesendet: Montag, 8. Mai 2017 15:22
> > An: Kitodo Community <kitodo-community at kitodo.org>
> > Betreff: [Kitodo] Kitodo Dokumentation Wunschliste
> >
> > Liebe Kolleginnen und Kollegen,
> >
> > dankenswerterweise gibt es inzwischen einiges an Dokumentation im
> Wiki von Kitodo.Production, beispielsweise Anwenderdokumentation,
> die mehrere Kitodo-Bibliotheken beigesteuert haben:
> >
> > https://github.com/kitodo/kitodo-production/wiki.
> >
> > Allerdings gibt es auch noch große weiße Flecken, also Teilbereiche, die
> gar nicht oder nur spärlich mit Dokumentation abgedeckt sind.
> >
> > Hier ein paar Themen aus meiner Wunschliste:
> >
> > * Installation und Inbetriebnahme einer Website mit
> >    TYPO3 und Kitodo.Presentation
> >
> > * Praxistipps rund um Arbeitsschritte, die mit dem Thema
> >    Digitalisierung zu tun haben, beispielsweise
> >
> >    * Empfehlungen zum Thema Scannen (Scannereinstellungen,
> >      Umgang mit schwierigen Vorlagen, ...)
> >
> >    * Nachbearbeitung von gescannten Seiten für Präsentation / für OCR.
> >      Beispiele: Beschneiden, Unscharf Maskieren,
> >      Farb- und Kontrastoptimierung
> >
> >    * Texterkennung (OCR). Etwas Info steht unter
> >      https://github.com/kitodo/kitodo-production/wiki/OCR
> >
> >    * Langzeitarchivierung. Etwas Info steht unter
> >      https://github.com/kitodo/kitodo-
> production/wiki/Kitodo.Production-und-Langzeitarchivierung
> >
> > Es geht mir also nicht nur um die Kitodo-Software, sondern um alle
> Arbeitsschritte im Umfeld "Digitalisierung".
> > Auch andere (freie) Software fällt darunter.
> >
> > Sicher haben andere Kitodo-Anwender noch weitere Themen auf ihrer
> Wunschliste. Auch diese Wünsche gilt es zu sammeln und zu
> dokumentieren.
> >
> > Besteht Interesse, derartige Dokumentation an einer zentralen Stelle
> zu sammeln? Wo? Alles im Wiki von Kitodo.Production?
> > Manchmal genügt vielleicht schon der Hinweis (Link), wo gute
> Dokumentation zu finden ist.
> >
> > Mit freundlichen Grüßen
> > Stefan Weil
> >
> >
> > _______________________________________________
> > Kitodo-Community mailing list
> > Kitodo-Community at kitodo.org
> > https://maillist.slub-dresden.de/cgi-bin/mailman/listinfo/kitodo-
> community
> >
> > _______________________________________________
> > Kitodo-Community mailing list
> > Kitodo-Community at kitodo.org
> > https://maillist.slub-dresden.de/cgi-bin/mailman/listinfo/kitodo-
> community
> 
> --
> Alexander Bigga
> Referatsleiter Digitale Bibliothek
> 
> Sächsische Landesbibliothek –
> Staats- und Universitätsbibliothek Dresden (SLUB)
> Abteilung IT, Referat 2.1 Digitale Bibliothek
> 01054 Dresden
> Besucheradresse: Zellescher Weg 18
> Tel.: +49 351 4677 212
> E-Mail: alexander.bigga at slub-dresden.de
> 
> http://www.slub-dresden.de/
> 
> 
> _______________________________________________
> Kitodo-Community mailing list
> Kitodo-Community at kitodo.org
> https://maillist.slub-dresden.de/cgi-bin/mailman/listinfo/kitodo-
> community
_______________________________________________
Kitodo-Community mailing list
Kitodo-Community at kitodo.org
https://maillist.slub-dresden.de/cgi-bin/mailman/listinfo/kitodo-community