+- RouteConverter Forum (https://forum.routeconverter.com)
+-- Forum: Developers (https://forum.routeconverter.com/forum-6.html)
+--- Forum: Development (https://forum.routeconverter.com/forum-13.html)
+--- Thread: Dokumentation (/thread-3091.html)
Dokumentation - Hossi - 06.10.2020
Hallöchen,
ich bin neu hier und würde mich dafür interessieren, ob es irgendwo ein bisschen Dokumentation gibt?
Hi, im new here. Is there any documentation for RouteConverter?
RE: Dokumentation - kumo - 07.10.2020
Moin...
RC stammt aus Deutschland. Insofern ist die Frage in Deutsch schon richtig gestellt
Klicke dich mal durch die auf der Homepage in 'Eigenschaften' vorhandenen Links.
Dahinter verbergen sich viele Fallbeispiele, die Christian und ich dort einst hinterlegt haben.
Fallbeispiele sind auch unter 'Anwendungen' zu finden.
In die FAQ sind auch viele Fragen eingeflossen.
Das ist letztlich unsere Version der Bedienungsanleitung.
RE: Dokumentation - Hossi - 07.10.2020
Ja, sorry, habe mich evtl etwas unklar ausgedrückt
Das "Benutzerhandbuch" hab ich schon gefunden. Mir ging es wirklich um ein bisschen entiwcklungsspezifische Dokumentation (Beschreibungen was in welcher Komponente zu finden ist, wie, wo das ganze System zusammengebaut wird).
Finde es aktuell ein bisschen mühselig mich im Code einzulesen, wenn es keine Architekturdoku und keine Codekommentare gibt.
Deswegen die Frage ob ich die irgendwo übersehen habe oder ob es inoffiziell irgendwas in die Richtung gibt?
Schönen Abend,
Hossi
RE: Dokumentation - routeconverter - 19.10.2020
(07.10.2020, 18:09)Hossi Wrote: Mir ging es wirklich um ein bisschen entiwcklungsspezifische Dokumentation (Beschreibungen was in welcher Komponente zu finden ist, wie, wo das ganze System zusammengebaut wird).
Lies mal das README.md von https://github.com/cpesch/RouteConverter/
(07.10.2020, 18:09)Hossi Wrote: Deswegen die Frage ob ich die irgendwo übersehen habe oder ob es inoffiziell irgendwas in die Richtung gibt?
Es gibt nur Source Code, den ich versucht habe, möglichst gut zu strukturieren und zu benennen.
Warum? Weil ich die ganzen Jahre immer mal wieder nach mehr Entwicklerdokumentation gefragt wurde, aber Contributions stets nur von Entwicklern kamen, die das nicht benötigten. Also habe ich die Zeit in Tests, Features usw. gesteckt.
RE: Dokumentation - Hossi - 19.10.2020
Ja.. das erklärt warum die Contributions nur von Entwicklern kamen, die sich die Mühe gemacht haben sich so durchzupfrimeln ;D
Ich möchte keineswegs sagen, dass die Strukturierung in Module unübersichtlich ist, aber das Fehlen einer Doku erschwert halt einfach den Einstieg, wenn man gerne eine Kleinigkeit ändern möchte. Mit Doku könnte man eben einfach wie in ner Checkliste vorgehen und schauen: Was will ich ändern? Welche Module betrifft das eigentlich? Welche Funktionalitäten betrifft das eigentlich.
Das Readme enthält nur Infos wie man das Projekt überhaupt erstmal bei sich einbindet und zum laufen bringt. Das ist ok, bringt aber nur was für die Einrichtung, nicht bei der Einarbeitung.
Mal schauen, ob ich die Zeit erübrigen kann mich einzuarbeiten. Falls ich dazu komme schreib ich mal ein bisschen Doku. Dann gibts da dann für die Zukunft vlt zumindest teilweise was und fördert evtl auch die Contributer-zahlen
RE: Dokumentation - routeconverter - 20.10.2020
(19.10.2020, 20:38)Hossi Wrote: Mal schauen, ob ich die Zeit erübrigen kann mich einzuarbeiten. Falls ich dazu komme schreib ich mal ein bisschen Doku. Dann gibts da dann für die Zukunft vlt zumindest teilweise was und fördert evtl auch die Contributer-zahlen
Das wäre klasse. Du kannst auch hier Fragen stellen. Wenn ich wüsste, was Du ändern möchtest, könnte ich Dir Hinweise geben.