Éditeur pour la documentation de l'utilisateur final en C # WinForm application

Question

Je développe une application WinForm en C # 4.0 et voudrais d'autres (non-développeurs) collègues de contribuer à écrire un contexte sensible utilisateur final helpfile. D'abord, je pensais que je pourrais utiliser « HTML Help Workshop » de Microsoft, mais il semble obsolète (Vista et Windows 7 pas pris en charge). Ensuite, je l'ai regardé Sandcastle, mais la documentation MANQUE et je me demande s'il est adapté pour les utilisateurs non-techniques à la documentation d'écriture de l'utilisateur final. Donc, j'ai lu RoboHelp, mais il est beaucoup trop cher pour moi. Je me perdre dans toutes les informations disponibles sur les fichiers d'aide. aider quelqu'un peut donner des bonnes pratiques ou des informations sur les outils à utiliser et quel format de sortie I devrait cibler (encore CHM ou autre).

Answer 1

Grande question. Je aime votre idée de non-développeurs contribuant à la documentation utilisateur final.

utilisateurs Might idée de motiver et testeurs de votre application de contribuer facilement à la documentation.

La première chose qui me vient à l'esprit, utilise une certaine sorte de moteur de wiki. Vous pouvez construire une fonction simple dans votre application WinForm, que les incendies un navigateur et dirige dans le wiki. Vous pouvez utiliser le contexte dans lequel il est appelé à construire une URL; par exemple. http://dev-wiki.mycompany.com/LoginForm?action=edit. Voici le nom de la forme ( « LoginForm ») est utilisé dans l'URL d'une page wiki.

Sinon, vous pouvez simplement utiliser le contrôle du navigateur Web WinForms pour accéder au wiki. Cela ressemblerait à quelque chose comme:

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

Ce serait très facile à intégrer dans votre application.

ce serait très facile dans un environnement contrôlé (bureau), de mettre en place. Dans votre environnement de production, il est peut-être un peu plus difficile, mais faisable. Il pourrait tirer parti des contributions de l'utilisateur final aussi.

Answer 2

Pour écrire la documentation, j'utiliser sphynx. Il vous permet de documenter en clair et a différents formats de sortie (CHM, html, pdf, etc.).

Certains d'entre eux (CHM, html) peuvent être utilisés comme sources d'aide contextuelle.

Cependant simple, l'interface utilisateur de sphynx (éditeur de texte et Makefile) pourrait ne pas être approprié pour les utilisateurs non-techniques.

Answer 3

Je recommande d'utiliser Aide + Manuel pour créer la documentation CHM. Il est similaire à MS Word et tout utilisateur de PC peut commencer à contribuer au développement de doc après une courte formation. Mais cet outil n'est pas gratuit: (