Programmdokumentation erstellen (Womit, Wie)?

[ReKoR]

Hallo zusammen,

ich nutze dieses klasse Forum schon seit längerem. Nun ist es aber an der Zeit für den ersten Thread

In unserer Firma sitzen Anwendungsentwickler (zu denen ich mich auch zähle) und -nutzer unter einem Dach. Gerade weil wir unsere Software niemandem verkaufen, tun wir uns mit einer Doku sehr schwer. Bisherige Versuche mit einer Lotus Notes DB und dem aktuellen Ansatz, Dokus zu einem Projekt in einem Netz-LW abzulegen (meist mit Office erstellt),
können nicht als erfolgreich bezeichnet werden.

Wir sind nun deshalb auf der Suche nach einer frischen modernen Lösung.

Die Anforderungen:

• Suchfunktion über Titel + Inhalt
• klar da müssen Bilder mit rein
• Kategorisierung
• leicht zu bearbeiten und erstellen

Da ich selbst schon seit vielen Jahren aus privatem Interesse PHP programmiere und ein leidenschaftlicher Nutzer des Internets bin, dachte ich sogleich an MediaWiki (Softwarebasis von Wikipedia). Leider ist hier das Erstellen von Artikeln etwas gewöhnungsbedürftig. Nicht jeder unserer Programmierer surft so oft im Inet und ist mit Board-Codes oder HTML-Code vertraut.

Das Optimum wäre demnach ein MediaWiki (browserbasiert find ich irgendwie am besten ), das man im Stil von Word bearbeiten kann. Nicht zu vergessen ist auch, dass die bestehenden Dokus in Word und Notes ohne rießigen Zeitaufwand in das neue System integriert
werden können.

Über ein paar Anregungen wäre ich sehr dankbar.

MfG ReKoR

[holgerscherer]

Das Optimum wäre demnach ein MediaWiki (browserbasiert find ich irgendwie am besten ),

Wir arbeiten inzwischen auch mit MediaWiki - mehrere Wikis für interne Doku für die Entwickler bis zur User-Doku, die man per Mausklick aus dem GreenScreen aufrufen kann. Ist meines Erachtens einfach und praktikabel. Nur nimm (bei gewisser Anzahl User) eine Linux-Möhre, auf der iSeries zieht PHP/MySQL doch recht viel Leistung...

(ich habe ein Wiki sogar mit XAMPP unter Windows laufen. Funktioniert sogar ;-)

-h

[ReKoR]

Hallo Holger,
danke für die Antwort.

Wir arbeiten inzwischen auch mit MediaWiki

Wie funktioniert das bei euch genau? Dürfen alle etwas schreiben, so wie es sich im Wiki gehört? Wenn ja, wie kommen die User mit der Syntax zurecht? Ich denke, dass das der Knackpunkt ist. Die Begeisterung hielt sich in Grenzen, als ich meine kleine Testanwendung mal vorgeführt habe.

[..] die man per Mausklick aus dem GreenScreen aufrufen kann.

Wie funktioniert das? Über ClientAccess?

ich habe ein Wiki sogar mit XAMPP unter Windows laufen. Funktioniert sogar ;-)

Dito! Mein Testwiki läuft auf ebenso unter XAMPP auf meinem privaten PC, auf den ich via Internet zugreife

[prsbrc]

Ich könnte mir vorstellen, dass der Link per STRPCCMD an den CA gesendet wird welcher wiederum den Befehl ausführt. Oder?

[holgerscherer]

Ich könnte mir vorstellen, dass der Link per STRPCCMD an den CA gesendet wird welcher wiederum den Befehl ausführt. Oder?

Nuja, meine GUI macht das natürlich anders, da platziere ich Buttons nach Belieben, aber fast jede 5250-Emulation macht
aus dem Text "http://www.mywiki.xyz/artikel.php/blabla" einen klickbaren Button.

-h

[holgerscherer]

Dürfen alle etwas schreiben, so wie es sich im Wiki gehört? Wenn ja, wie kommen die User mit der Syntax zurecht?

Mit der Syntax kommt man mit der Zeit schon klar, zur not kann man redaktionell nachbearbeiten - der Inhalt ist auch wichtig.

Schreibzugriff sollte abhängig von der Art der Doku sein:
- willst Du eine unternehmensweite Wissensbasis aufbauen, sollte jeder schreiben dürfen, der was beizutragen hat
- das Entwickerwiki wird nur von den Entwicklern beschrieben und ist auch nur für diese lesbar
- die Userdoku wird von Entwicklern und "Hilfsredakteuren" (ähm) bestückt und kann von jedem gelesen werden.

-h