2009-05-17 6 views
4

Wir möchten die Software-Nutzungsdokumentation für eine Web-Anwendung vorbereiten. Dies beinhaltet hauptsächlich die Screenshots (zusammen mit der relevanten Dokumentation) auf den meisten Seiten. Außerdem möchten wir eine Top-Menü-Links haben, mit denen wir zu den entsprechenden Seiten springen können.Tools zur Software-Verwendung für Web-Anwendungen

Bitte schlagen Sie die Werkzeuge vor, die nützlich sein können, um die oben genannten Anforderungen zu erfüllen.

Antwort

0

Ich bin mir sicher, dass es da draußen ein tolles Werkzeug gibt, das alles für die Anwendungsdokumentation integriert, aber ich sage dir, was ich benutze!

Ich benutze wink, um Screenshots der Anwendung zu verwenden. Ich neige dazu, es zu feuern und einfach eine Menge Screenshots zu nehmen, während ich durch die Anwendung gehe, oder auch nur einen Teil der Anwendung. Als nächstes bearbeite ich das Projekt in Zwinkern, um überflüssige Bildschirmaufnahmen zu entfernen, sie neu zu ordnen und die Maus auf jeden Rahmen zu positionieren. Ich füge dann Hervorhebung hinzu, die normalerweise nur eine nette Box um den Teil des Bildschirms ist, den ich demonstriere. Wink ermöglicht es Ihnen, die Bilder mit Informationsboxen und Pfeilen zu überlagern, ich exportiert das Projekt dann als HTML und benutze die nummerierten, exportierten PNG-Bilder als Basis für meine Dokumentation.

Ich neige dazu, sie in OpenOffice Writer (oder was auch immer Sie für Satz setzen) zu ziehen und sie mit mehr Informationen zu ergänzen - dh ein paar Absätze oben erklären, was der Benutzer macht und warum.

Wir verwenden acrobat, um diese Dokumentation auszugeben. Wenn Sie Ihr Inhaltsverzeichnis korrekt erstellt haben, können Sie Lesezeichen in die PDF-Datei einfügen, um den Sprung zu relevanten Abschnitten zu ermöglichen.

Der Hauptvorteil von wink ist, dass es sehr einfach ist, Aufnahmen wieder aufzunehmen, wenn sich die Dinge ändern, und es in Flash ausgeben kann, um nette, pfiffige Demos von kleinen Funktionen für das Posten im Web bereitzustellen.

1

Das mag für Ihr Projekt übertrieben sein, aber ich habe die Dokumentation in Docbook (xml) bevorzugt, da es fantastisch portierbar/konvertierbar ist.

die Dokumentenerstellung zu vereinfachen, Sie http://www.oxygenxml.com/ drehen können, aber man kann auch in fast jedem anderen XML (oder sogar Text) Editor die gleiche Arbeit tun.

Sobald Ihr Dokument vorbereitet ist, ist es trivial, HTML (mehrseitige oder einzelne Seite) und PDF-Versionen zu generieren.

2

Dr Erklärung ist ziemlich nett.

http://www.drexplain.com/

Es wird Ihre Seite analysieren und eine Liste der Steuerelemente, Schaltflächen erstellen usw., die Beschriftungen benötigen.

2

Wenn Sie Ihre Dokumentation mit einem bestimmten Dokumentationswerkzeug schreiben, ist die Ausgabe in HTML relativ einfach. LaTex, Markdown (mit Pandoc im Hinterkopf), reStructuredText (mit Pandoc oder Sphinx im Hinterkopf), AsciiDoc (mit DocBook-Tools im Hinterkopf) und DocBook (mit Docbook-Tools im Hinterkopf - siehe Pandoc).

Alle diese Formate würden Ihnen erlauben, Ihre Dokumentation leicht zu organisieren und sie dann in HTML zu exportieren, wie Sie es für richtig halten (wahrscheinlich durch Hauptüberschrift, dann erstellen Sie einen einfachen Wrapper um die Dateien). Sphinx kann auch nur webbasierte Dokumentation ausgeben (siehe Dokumentation von Python.org).

Für Screenshots schlage ich vor, eine Standalone-App auf der Plattform Ihrer Wahl zu verwenden. Idealerweise können Sie eine Annotation innerhalb des Programms vornehmen. Skitch für Mac, Jing für Windows, Shutter shutter-project.org oder Jing in Linux.

Endlich würde ich vorschlagen, auch Screencasts zu machen, da sie besonders hilfreich sein können, um die Attraktivität/Kraft einer Web-App zu demonstrieren.

1

Ich weiß nicht, welcher König der Sprache Sie Ihren Code schreiben, aber im Fall Java können Sie Maven verwenden.

Mit Maven können Sie viele Plugins verwenden, wie JavaDoc, site, die eine Seite mit vielen Informationen über Ihre API/Software erstellen und enthält das obere Menü, die Sie wollen. Diese

ist ein Screenshot der Website, die maven erzeugt: link

Ich hoffe, dass diese helfen könnte!

Cheers

Verwandte Themen