2010-09-08 18 views
0

Nous avons développé une application dans C# .net et visons à la rendre déployable sur notre intranet. Nous aimerions avoir une documentation solide à suivre, mais nous ne sommes pas sûrs de la meilleure plate-forme pour documenter cela. Des outils disponibles pour faciliter ce processus?Comment dois-je documenter mon application?

J'ai découvert Doxygen, Htmlhelp ou le Dr Explain mais je ne suis toujours pas convaincu de l'utilisation.

+0

Quelle classe de documentation cherchez-vous à fournir? Pour les utilisateurs de l'application? Pour le support d'application? (service desk etc) Pour le développement? (bibliothèques réutilisables, ou développement ultérieur) – Rudu

+0

Pour les développeurs et les instructions pour les utilisateurs de configurer le système – user391986

Répondre

3

Si vous voulez générer quelque chose de similaire à MSDN, vous pouvez essayer Sandcastle (qui est créé par Microsoft).

Vous pouvez utiliser le Help File Builder pour les utilisateurs ou Documentation Compiler for Managed Class Libraries si votre application est une bibliothèque partagée pour d'autres développeurs (bien que, d'après votre description, il semble que vous souhaitiez utiliser le Générateur de fichiers d'aide).

2

Si vous souhaitez une documentation de code de type MSDN, vous pouvez également essayer VSdocman.