Editor für Endbenutzerdokumentation in C # WinForm app

Question

Ich entwickle ein WinForm app in c # 4.0 und viele andere (nicht-Entwickler) Kollegen eine kontextsensitive Endbenutzers Hilfe Datei beitragen zu schreiben. Zuerst dachte ich, ich „HTML Help Workshop“ von Microsoft verwenden könnte, aber es scheint veraltet (Vista und Windows 7 wird nicht unterstützt). Dann im Sandcastle Ich habe gesucht, aber die Dokumentation fehlt, und ich frage mich, ob es geeignet für technisch nicht versierten Anwender ist Schreib Endbenutzer-Dokumentation. Also habe ich über RoboHelp lesen, aber für mich zu teuer es den Weg. Ich bin immer in allen Daten verloren, die über Hilfe-Dateien zur Verfügung. Kann jemand helfen einige bewährte Methoden oder Informationen geben, welche Werkzeuge verwenden und was Ausgabeformat sollte ich (noch chm oder andere) Ziel.

Answer 1

Gute Frage. Ich mag Ihre Idee von nicht-Entwickler einen Beitrag zur Endbenutzer-Dokumentation.

Diese Idee könnte motivate Anwender und Tester Ihrer Anwendung leicht in der Dokumentation beitragen.

Das erste, was mir in den Sinn kommt, eine gewisse Art von Wiki-Engine verwendet. Sie könnten eine einfache Funktion in Ihrer WinForm-Anwendung, dass die Brände einen Browser erstellen und leitet in das Wiki. Sie könnten den Kontext verwenden, von dem es aufgerufen wird, eine URL aufzubauen; z.B. http://dev-wiki.mycompany.com/LoginForm?action=edit. Hier wird der Name des Formulars ( „Loginform“) wird in der URL einer Wiki-Seite verwendet wird.

Alternativ können Sie einfach verwenden, um die eingebettete Web-Browser-Steuerung WinForms das Wiki zugreifen. Das wäre in etwa so aussehen:

var url = GetWikiUrl(myForm);
browserControl.Navigate(url);

Das wäre sehr einfach in Ihrer Anwendung einbetten.

In einer kontrollierten (Büro) -Umgebung, wäre dies sehr einfach einzurichten. In Ihrer Produktionsumgebung könnte es ein bisschen schwieriger, aber immer noch machbar sein. Es könnte auch einige Endbenutzer Beiträge nutzen.

Answer 2

Für das Schreiben von Dokumentation, verwende ich Sphinx . Damit können Sie im Klartext dokumentieren und verschiedene Ausgabeformate hat (chm, html, pdf usw.).

Einige dieser (chm, html) als kontextsensitive Hilfe Quellen verwendet werden.

So einfach, das Sphinx User-Interface (Texteditor und Make-Datei) möglicherweise nicht für technisch nicht versierte Benutzer geeignet sein.

Answer 3

würde ich empfehlen, für die Erstellung von CHM-Dokumentation Help + Manual zu verwenden. Es ist ähnlich wie MS Word und jeder PC-Nutzer beginnen doc Entwicklung nach kurzer Ausbildung beizutragen. Aber dieses Tool ist nicht frei: (