Editor de documentación del usuario final en C # WinForm aplicación

Question

Estoy desarrollando una aplicación WinForm en C # 4.0 y quisiera otros colegas (no-desarrollador) para contribuir escribir un archivo de ayuda sensible a contexto del usuario final. Primero pensé que podría utilizar "HTML Help Workshop" de Microsoft, pero parece anticuado (Vista y Windows 7 no son compatibles). Luego he mirado Castillo de arena, pero la documentación es deficiente y me pregunto si es conveniente para los usuarios no técnicos a la documentación de escritura para el usuario final. Así que leí acerca de RoboHelp, pero es demasiado caro para mí. Me estoy perdido en toda la información disponible acerca de los archivos de ayuda. Alguien puede ayudar a dar algunas de las mejores prácticas o información sobre qué herramientas a utilizar y qué formato de salida que debe dirigirse (todavía CHM u otro).

Answer 1

Muy buena pregunta. Me gusta su idea de que no son desarrolladores que contribuyen a la documentación de usuario final.

Esta idea podría motivar a los usuarios y probadores de su aplicación a contribuir fácilmente a la documentación.

La primera cosa que viene a la mente, se utiliza una cierta clase de motor de wiki. Se puede construir una función simple en su aplicación WinForm, que dispara un navegador y dirige en la wiki. Se podría utilizar el contexto desde el que se llama a construir una URL; p.ej. http://dev-wiki.mycompany.com/LoginForm?action=edit. Aquí el nombre de la forma ( "LoginForm") se utiliza en la URL de una página wiki.

Como alternativa, puede simplemente usar el rel="nofollow"> el control del navegador web integrado para WinForms para acceder a la wiki. Eso sería algo como:

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

Esto sería muy fácil de integrar en su aplicación.

En un ambiente controlado (oficina), esto sería muy fácil de configurar. En que entorno de producción que podría ser un poco más difícil, pero se puede hacer. Se podría aprovechar algunas de las contribuciones de los usuarios finales también.

Answer 2

Para escribir documentación, uso esfinge . Se le permite documentar en texto plano y tiene varios formatos de salida (CHM, HTML, PDF, etc.).

Algunos de éstos (chm, html) se pueden utilizar como fuentes de ayuda sensibles al contexto.

Sin embargo simple, la interfaz de usuario esfinge (editor de texto y el archivo make) podría no ser adecuado para los usuarios no técnicos.

Answer 3

Yo recomendaría usar Ayuda + Manual para la creación de documentación CHM. Es similar a MS Word y cualquier usuario de PC puede comenzar a contribuir el desarrollo doc después de la educación corta. Pero esta herramienta no es gratuita: (