Seite 1 von 1
Tool zum erstellen von Dokumentationen
Verfasst: 01.07.2008, 14:51
von pvdb
Hi,
es geht darum dass ich gerne eine Dokumentation für eine Software erstellen möchte. Hier sollen z.B. Schnittstellen erläutert, aber auch die Bedienung mit Screenshots beschrieben werden.
Wollte mal Fragen ob jemand ein PHP/MySQL Script kennt, was für diese Zwecke gut geeignet ist. Gerne auch ein Script, welches statische HTML Seiten generiert.
Wäre natürlich schön, wenn das ganze dann noch Seo freundlich ist.
Was würdet ihr vorschlagen?
Phil
Verfasst: 01.07.2008, 16:07
von chrizz
screenshot? Irfanview.... und dann halt OPenOffice oder so nutzen...?
sorry, ich versteh das Problem grad nicht ganz so.... automatisiert ne Doku erstellen wird doch sowieso nix...
Verfasst: 01.07.2008, 16:31
von pvdb
Automatisiert soll und kann da nichts erstellt werden.
Wenn ich nun alles im HTML mache und dann z.B. 100 HTML Seiten erstellt habe und dann in Sachen Design etwas ändern will, habe ich keinen Bock alle 100 Seiten zu bearbeiten. Weiterhin wollte ich nicht selbst eine Engine dafür bauen, weil dies nur ein Bestandteil eines Projekts ist, aber kein eigenes Projekt.
Ideal wäre so nen PHP Script. Wo man einzelne Kapitel anlegen kann. Also Texte eingeben, Bilder einfügen, verweise auf andere Kapitel/Unterkapitel, .... Design wird dann als Template global verwaltet.
Per Knopfdruck werden dann statische html Seiten erstellt, die nur noch auf den Server geladen werden.
Sowas in der Art Suche ich. Ich will keine Funktionen des Quellcodes beschreiben, wie es bei javadoc z.B. der Fall ist.
Verfasst: 01.07.2008, 16:57
von Zerstreuter
Schonmal an ein
>>>Wiki<<< gedacht?
Verfasst: 01.07.2008, 17:37
von propaganda
Falls Du etwas professionelles suchst, dann sieh Dir mal
XMetal an.
Verfasst: 01.07.2008, 22:36
von pvdb
Danke für den Tipp. Ein Wiki ist eine gute Idee. Das MediaWiki ist mir jedoch etwas zu umfangreich, ich werde aber mal schauen was für Wikis es noch so gibt. Hatte gar nicht dran gedacht.
