Alphatester für Dokumentationssystem

[igel457]

Hallo,

nachdem ich mit meiner mit Pasdoc generierten HTML-Sourcecode-Dokumentation für Andorra 2D (http://andorra.sf.net/docs/) nicht sonderlich zufrieden war, habe ich mich die letzten beiden Wochen drangesetzt und einen XML, SQL und GraphViz-Exporter für PasDoc nebst zugehörigem PHP-Script zusammengeschustert.

Dieses PHP Script formatiert die XML Dateien entsprechend, verlinkt alles untereinander und stellt eine mit SQL realisierte Volltextsuche in der Dokumentation zur Verfügung.

Da ich die Dokumentation jedoch nicht für mich, sondern vor allem für die Benutzer gebaut habe, würde ich mich freuen, wenn ihr euch das System mal anschauen könntet und konstruktive Kritik oder Feedback (gerne auch positives ) dazu äußert.

Über jeden gefundenen Bug würde ich mich freuen aber auch vor allem Meinungen zu Usability und Layout würden mich interessieren.

Haupt-URL:
http://andorracommons.sf.net/docs/

Suche:
http://andorracommons.sf.net/docs/index.php?q=

Das Ganze ist noch nicht für den produktiven Einsatz gedacht, unter anderem die URLs können sich noch ändern. Importiert sind momentan die komplette Source-Code-Doku für Andorra 2D (4.5.1), Audorra (SVN) und Andorra Commons (SVN).

Getestet wurde die Seite bisher ausschließlich mit Chrome und Firefox 3.6, Internet Explorer teste ich, sobald ich mein Windows mal wieder gestartet habe.

Bekannte Probleme/Fehler:
Das Ganze ist bis jetzt noch nicht ganz fertig, folgende Bugs sind mir (unter anderem bekannt)

• Enumerationen werden noch nicht angezeigt
• Überladene Funktionen werden noch nicht angezeigt
• BB-Code Tags werden in der Volltextsuche ungehighlighted angezeigt
• Die Unit-Übersichtsseite existiert noch nicht.
• Besonders im Audorra-Part sind einge Teile sehr gut Dokumentiert (TAu3DAudio), andere jedoch nicht

Getestet mit:

• Firefox 3.6
• Chrome
• Opera

Suchbegriffe/Themen zum Testen:
Da nicht jeder schnell mal ein paar Begriffe und Themen hat, hier ein paar Sachen um die Suche zu testen:

• TAu3DAudio
• audio play
• wasapi
• todo heck
• AuAudio
• openal

Crosspost zu DelphiGL: http://www.delphigl.com/forum/viewtopic.php?f=4&t=9328

Schonmal Danke,
Andreas