wisydb / wisy

Open Source CMS for Training and Educational Purposes
Other
1 stars 3 forks source link

Dokumentation überarbeiten #26

Open svenkaemper opened 6 years ago

svenkaemper commented 6 years ago

Mittel- bis langfristig sollte man die WISY-Dokumentation unter https://b2b.kursportal.info überarbeiten und in ein für die jeweiligen Zielgruppen (Redakteure, Entwickler) passendes Format bringen.

(Unter https://www.gitbook.com/book/svenkaemper/wisypedia/details hatte ich exemplarisch einmal ein paar Seiten aus dem aktuellen WISY-Wiki angelegt: einfach auf „Read“ klicken, um zur Browserversion des Buchs zu gelangen)

wisydb commented 5 years ago

Ich fände es evtl. sinnvoll bestimmte Seiten, speziell für Entwickler hier bei Github zu haben (Installation, REST-Schnittstelle, DB-Struktur). Dazu besteht die Möglichkeit einen Wiki anzulegen (s. Navigatonsleiste). Es wäre also wiederum ein Wiki, etwas hübscher als aktuell und an einer Stelle, an der man sowas finden will. Aber mehr als die paar Seiten sehe ich nicht und bereits die REST-Schnittstelle (welche die am meisten nachgefragte für Externe ist) ist bereits für unseren Anwendungsfall serverbezogen (welche Domains/Sandboxen aufzurufen sind). Hier bei Github würde man dagegen im allgemeinen bleiben, was dazu führt, dass die betroffenen Externen doch wieder nachfragen müssen, welche Adressen sie nun konkret aufrufen müssen. Es kann also nur ein allgemeineres Duplikat sein, ebenso was die Installationsanleitung angeht (diese ist bisher nur ein rudimentärer Text, den ich aus Eigentinteresse mal für mich in Stichworten angelegt habe).

Wollte man das ganze bisherige Wiki in ein anderes Format bringen und inhaltlich Trennen müsste man sich nach einem noch konkreten Ziel fragen außer Zielgruppentrennung und Ansichtsverbesserung - bisher kommen die Leute damit zurecht und die Zielgruppen überschneiden sich: Entwickler müssen manchmal Menü-/Portaleinstellungen vornehmen, Redaktionen müssen manchmal DBMix-ini-Dateien anlegen usw. D.h. man kann es nicht sauber trennen. Was die .ini-Dateien z.B. angeht bin ich auch nicht sicher, ob ein solcher Text, der 1:1 in eine Datei übertragen werden muss, nicht in anderen Systemen mehr verstümmelt wird - oder man muss die Redaktionen erst in Code-Schreibmodus usw. schulen.

Jede Lösung der Überführung in ein anderes System muss zudem einen automatischen Import aller Seiten ermöglichen (bis auf die 2-4 ganz oben erwähnten Anleitungen), weil es sich um rund 6.000 Seiten handelt: https://b2b.kursportal.info/index.php?title=Spezial:Alle_Seiten&from=API Wer das wie manuell stemmen will ist die Frage oder die Leute müssen über Monate immer an zwei Stellen suchen. Gut, viele dieser Seiten sind nur Importdokumentationen, die leicht als "Importe" zu subsumieren sind. Aber trotzdem nicht ohne.

Dagegen hielte ich für sinnvoll:

Was spricht gegen Gitbook:

Ich bin sehr wohl dankbar für die Anregung! Aber wollte selber mal das für und wieder abwägen... Die größere Dringlichkeite scheint mir aber die Auffindbarkeit im Wiki zu erhöhen und die Leute dazu anzuhalten (nicht Euch!), überhaupt sinnvoll zu dokumentieren sowie veraltete Inhalte ggf. zu löschen.