MyMDb-CE Handbuch

Issue #74 resolved
MxO2204 created an issue

Version: 1.2.0 OS: Windows 10

Nachdem ich durch die Neugestaltung auf die Filter/Gruppen Funktion aufmerksam geworden bin, habe ich mal gesucht, für was das verwendet werden kann. Dabei bin ich auf das alte MyMDb Handbuch (als PDF) gestoßen -> Link. Dort habe ich dann ein paar Anregungen gefunden - und endlich kapiert, wofür ich die Filter/Gruppen Funktion verwenden kann :-) Ist ja eine feine Sache!

Evtl. sollte so ein Handbuch auch für MyMDb-CE erstellt und dann auch verlinkt werden. Wäre bestimmt für Neueinsteiger eine gute Sache. Ist das schon in Arbeit? Nicht unbedingt als PDF sondern IMHO besser als Wiki.

Bis es ein Handbuch für MyMDb-CE gibt könnte man ja schon mal das alte Handbuch irgendwo verlinken..

Comments (11)

  1. tbengel

    Die Erstellung des Handbuches sehe ich nicht bei uns als Programmierer, sondern eher in der Hand von engagierten MyMDb-Mitgestaltern ;-))

    Jeder der sich nun angesprochen fühlt, kann sich gerne dieses Projektes annehmen ...

  2. Atze Danjo

    Ein Handbuch ist auf jeden Fall etwas das uns fehlt und ich sehe das ebenfalls als eine gute Möglichkeit für nicht-Programmierer etwas zu diesem Projekt beizutragen.

    Bei Interesse, könnten wir die Wiki-Funktion hier freigeben, oder einen Service wie https://readthedocs.org/ dafür nutzen.

    Ich würde mich auch gerne, im Rahmen meiner Fähigkeiten, daran beteiligen aber dazu müsste jemand anders erstmal den Anfang machen.

  3. MxO2204 reporter

    Also, um readthedocs.org verwenden zu können, müssten die Ersteller eines Handbuchs Developer Status haben, denn so wie ich das verstanden habe, lebt hier der Programm Code zusammen mit der Dokumentation z.B. bei Github oder Bitbucket. Und die Dokumentation muss in einer speziellen "Sprache" erstellt werden, die ist sicher einfach zu lernen, aber es muss halt auch erst mal gemacht werden. Evtl. ist das für einen "normalen" Software Anwender, der an der Doku mitarbeiten will, etwas zu kompliziert?

    Also sollten tatsächlich die Entwickler die Doku erstellen, was ja eben bei readthedocs.org auch so gewollt ist. Denn jede Änderung am Code erfordert normalerweise eine Bearbeitung der Dokumentation, und bei readthedocs ist das ja eben verbunden -> Code Änderung -> Doku Änderung.

    Also, ich finde das Konzept generell schon recht genial! Könnt Euch ja mal das ein oder andere Video zu readthedocs anschauen..

  4. Atze Danjo

    Hab mir jetzt mal readthedocs genauer angesehen, denke nicht, dass das für uns das richtige ist.

    Ich zitiere mal tbengel: Jeder der sich nun angesprochen fühlt, kann sich gerne dieses Projektes annehmen ...

  5. tbengel

    Man könnte sich auch untereinander absprechen, wer über was schreibt ... Macht einen eigenen Handbuch-Thread auf ... Es gibt auch Online-Lösungen zum gemeinsamen Editieren an einem Dokument.

    Also ich denke mal, wo ein Wille ist, da ist bestimmt auch ein Weg ...

    Die Programmierer und Nobby haben schon genug andere Sachen für die Weiterentwicklung von MyMDb-CE um die Ohren, so dass gerade diese Aufgabe eine der Herausforderungen ist, die jeder machen kann, der sich einigermaßen der deutschen Sprache mächtig fühlt und in Screenshots machen und bearbeiten seid ihr doch jetzt schon alle bereits spitze ...

    Also nicht so faul und ran an die Arbeit ... ;-))))

    Ein Handbuch wäre eine wichtige Unterstützung, ..., fast so wichtig wie das Testen!

  6. MxO2204 reporter

    @Atze, tja, der Vorschlag mit readthedocs kam ja von Dir, drum hab ich mir das auch mal angeschaut. Aber, wenn die Programmers es nicht in die Code Entwicklung mit aufnehmen wollen, und es von den Usern kommen soll, dann ist readthedocs wirklich nicht das was wir brauchen.

    Aber Du hast ja auch was von der "Wiki Funktion hier freigeben" geschrieben. Wie sieht das denn aus? Wo "lebt" denn dieses Wiki? Innerhalb des Gemeinschaftsforums? Dann könnte man ja wirklich darüber nachdenken, denn als Wiki könnte das Handbuch ja auch gut leben, einfach zu erstellen und zu pflegen, von mehreren Leuten.

    Könntest Du dir das mal anschauen? Und ggf. aktivieren? Und ggf. eine Grundstruktur anlegen? Bin sicher, dann finden sich auch Leute, die einsteigen!

  7. OldObelix

    @all

    Also ich würde mithelfen, sobald alles in Sack und Tüten ist!

    Ich würde die entsprechenden Screenshots zum Text, je nach Anfrage und gewünschter Vorgabe erstellen.

  8. Atze Danjo

    @MxO2204 Das war nicht wirklich ein Vorschlag sondern eher als Beispiel für eine "wir hosten deine Dokumentation"-Website. Meine Meinung ist hier eigentlich ziemlich egal, denke die Entscheidung, wo und wie das Handbuch erstellt wird, sollten diejenigen treffen, die das Handbuch erstellen.

    Ich meinte dieses Wiki https://bitbucket.org/mymdbce/mymdbce/wiki/browse/ dort kann jeder, der möchte, vorhandene Seiten bearbeiten und neue anlegen.

  9. MxO2204 reporter

    Nur zur Info.. Das Handbuch ist weitgehend fertig und sollte mit der nächsten oder übernächsten Version online gehen.

  10. tbengel

    Handbuch ist fertig und ist im Programmpaket mit dabei. Ganz großen Dank an Old.Obelix und seinen "Gehilfen" Mx02204. War ein super Job und wie ihr seht, kommt das Handbuch bei den Usern richtig gut an und wird gebraucht.

  11. Log in to comment