Autor Thema: "Lebende" Dokumentation - WIKI  (Gelesen 420 mal)

0 Mitglieder und 1 Gast betrachten dieses Thema.

Offline ADS_0x1

  • Newbie
  • *
  • Beiträge: 12
    • Profil anzeigen
"Lebende" Dokumentation - WIKI
« am: 20. Juni 2017, 23:37:27 »
Hallo Forum,

während dem Arbeiten mit der Bibliothek ist mir aufgefallen, dass an manchen Stellen die Dokumentation etwas der Lib hinterherhinkt, Bilder von alten Bausteinen verwendet werden und diverse Rechtschreibfehler auftreten. Mir kam daher die Idee, dass man die Doku ja auch als Wiki ausführen könnte, um das Ganze etwas interaktiver, besser vernetzt und vielleicht auch u.a. mit Beispielen etwas praxisnäher zu gestalten.

Bitte keine Klagen der Leiter hier - ich weiß, dass das wieder einiges an Mehrarbeit bedeuten würde, ich schätze die Arbeit, die bisher hier hinein geflossen ist, eine Wiki frisst Ressourcen und würde an anderer Stelle binden. Vielleicht habt ihr ja schon einmal darüber nachgedacht und es aus gutem Grund verworfen. Das hat wehemente Vor- und extrem viele Nachteile, dennoch könnte man darüber hier einmal diskutieren.

Viele Grüße,

Andreas

Offline peewit

  • Entwickler
  • *****
  • Beiträge: 2 219
    • Profil anzeigen
Re: "Lebende" Dokumentation - WIKI
« Antwort #1 am: 21. Juni 2017, 06:46:08 »
Hallo Andreas

Erstmals danke das du dir zum Thema Doku Gedanken gemacht hast

Die Idee mit dem WIKI ist an sich eine Gute aber momentan so auch nicht umsetzbar (Ressourcen)

Aber ein sinnvoller Schritt wäre wenn du und auch andere die gefundenen Doku-Mängel hier im Forum an einer Stelle sammeln
wurdet.

Dann steht einer Doku Aktualisierung relativ wenig im Wege

gruss peewit

Offline martin.k

  • Entwickler
  • *****
  • Beiträge: 171
    • Profil anzeigen
Re: "Lebende" Dokumentation - WIKI
« Antwort #2 am: 21. Juni 2017, 20:39:07 »
Hallo!

Ebenfalls von mir ein Danke an Dich.

Die Wiki-Idee finde ich total super. Vorallem weil man dort auch sehr gut Programmcode pflegen und beschreiben könnte.

Um das in die Tat umzusetzen wäre es super wenn sich noch andere Personen für diese Idee begeistern könnten.
Das Doku-Wiki muss nicht auf oscat.de (auch zwecks Benutzerkennung, Rechtevergabe usw.) laufen. Wichtig wäre, das jemand den Anfang macht.

Vielleicht kann ja ein anderer Benutzer mal schreiben was das Wiki können muss. Mir würde z.b. einfallen, das man ein PDF daraus erstellen können muss.

Grüße
Martin

Offline ADS_0x1

  • Newbie
  • *
  • Beiträge: 12
    • Profil anzeigen
Re: "Lebende" Dokumentation - WIKI
« Antwort #3 am: 22. Juni 2017, 09:41:22 »
Hallo peewit und Martin,

@peewit: Ich kann das gerne machen, nach Sichten der Kategorien/Themen hier im Forum bin ich mir unschlüssig, wo ich das machen soll. Kannst du mir hier sagen, in welchem Unter-Forum ich das machen soll?

@Martin: Da habe ich mir noch keine konkreten Gedanken drum gemacht. Ich bin jetzt "stumpf" von MediaWiki ausgegangen, die bietet ja schon allerhand Funktionen, die man braucht. Erwähnenswert ist hier die Gliederungs- und Strukturierungsoptionen, Syntaxboxen mit Highlighting, die Unterstützung von LaTeX-Math-Befehlen und deren Rendering für Formeln und zusätzlich die von dir geforderte Funktion, aus allem ein PDF zu machen (Buchfunktion - was ich allerdings noch nie getestet habe...)

Viele Grüße,

Andreas

Offline MarkusN

  • Newbie
  • *
  • Beiträge: 1
    • Profil anzeigen
    • E-Mail
Re: "Lebende" Dokumentation - WIKI
« Antwort #4 am: 18. August 2017, 15:10:07 »
Hallo zusammen,
das "Institute for Energy Efficient Buildings and Indoor Climate" (EBC) des E.On Energy Research Centers an der RWTH Aachen wird sich zukünftig auch an der OSCAT Entwicklung beteiligen. Genaue Details sind noch nicht mit den OSCAT Entwicklern abgesprochen, wir werden aber für unsere Arbeit definitiv ein Git-Repository inkl. Wiki anlegen.

Viele Grüße
Markus

Offline ADS_0x1

  • Newbie
  • *
  • Beiträge: 12
    • Profil anzeigen
Re: "Lebende" Dokumentation - WIKI
« Antwort #5 am: 05. September 2017, 21:56:47 »
Hallo Markus,

soll es dann die Git eigene Wiki werden oder ein eigenes Wiki?
BTW, wer treibt es bei euch voran (wer ist/wird/soll der Ansprechpartner/Projektleiter werden)? Wir haben n paar Kontakte an die Uni und sitzen in Monschau...

Viele Grüße aus der Eifel