Comment construire et de fournir la documentation pour les outils informatiques sous Windows? [fermé]

Question

Comment dois-je construire et fournir des documents pour un outil informatique sur Windows? Il y a une contrainte supplémentaire que je ne veux pas dépenser de l'argent sur les outils de création d'aide.

Ici, sur, nous parlons d'algorithmes et d'optimisation, des API et des performances. Mais l'un des résultats attendus de mes efforts de dev est la documentation. Quelle est la meilleure façon de le construire, et sous quelle forme dois-je livrer?

Si je présente un ensemble d'API .NET, un CHM est un mécanisme raisonnable pour la livraison. Il est très facile à utiliser SHFB pour construire le fichier d'aide dans le cadre de la construction, et si elle sera utilisée la plupart du temps sous Windows, un CHM est très accessible. Et la conversion du CHM à HTM rend le doc accessible encore plus largement.

Mais je veux livrer doc pour un filtre ISAPI qui sera utilisé non par les développeurs en eux-mêmes, mais par les administrateurs de serveur Web Windows. Je dois décrire l'installation, l'exploitation et la configuration. Je pense que les utilisateurs finaux peuvent avoir souvent développeur, ainsi que des compétences administratives, mais en tout cas, pour mes fins de la documentation couvrirai les tâches administratives et les questions opérationnelles.

Je sais que SHFB me permet d'inclure des fichiers réguliers HTML dans le CHM. Si je connais déjà SHFB, et si je ne veux pas dépenser de l'argent sur un outil d'aide-création, est-ce la meilleure façon d'aller? Sinon, quoi?

Answer 1

En fin de compte, j'ai décidé d'utiliser Sandcastle Help Builder fichier, l'outil gratuit disponible sur http: //shfb.codeplex .com . Je l'ai déjà utilisé Sandcastle pour construire le doc de référence pour un projet différent, donc je savais que quelque chose sur l'outil. Il produit des fichiers CHM ou .HxS, appropriés pour une utilisation sous Windows. Je ne l'avais jamais utilisé SHFB à « design » un helpfule avant, mais il était assez facile de comprendre comment le faire. Les résultats sont très bons.

Answer 2

Texlipse est un plugin de latex pour Eclipse. Les deux sont gratuits. Latext est utilisé par de nombreux chercheurs pour produire leurs papiers et est même utilisé pour de nombreux livres de texte. Il est un outil gratuit qui pourrait répondre à vos besoins.

Answer 3

Essayer cette asciidoc. Il n'est pas LaTeX, mais produit bien PDF / CHM / HTML et vous pouvez enseigner non-programmeur à écrire la documentation pour vous, ce qui est un joli bonus:)

Answer 4

Pourquoi ne pas écrire la documentation dans le bureau ouvert, puis l'exporter en format pdf?

Le latex est la manière professionnelle, mais pas rapidement accessible.