Ce qui est un bon outil pour la rédaction d'un manuel de l'utilisateur (fichier d'aide), qui s'intègre avec le contrôle de version
Les gens qui écrivent le manuel de l'utilisateur ne sont pas nécessairement les programmeurs, et ils ont besoin d'un éditeur visuel. Un problème majeur est le format interne de l'outil de création; il doit être lisible texte/html, il est donc facile de comparer les versions des pages individuelles vérifié dans le contrôle de version.
OriginalL'auteur Ola Eldøy | 2008-09-30
Vous devez vous connecter pour publier un commentaire.
Il y a d'autres produits qui permettent de fichier d'aide de l'écriture et qu'ils ont le soutien de "ID de contexte", ce qui rend l'aide contextuelle possible. Doc Pour Aider et RoboHelp sont ce type de produits.
RoboHelp est un Microsoft Word plugin si les fichiers d'aide sont en Micrsoft format word. Lorsque RoboHelp fait construire il crée les fichiers HTML dans le document Word. Au moins c'est la façon dont il a travaillé dans une version il y a quelques années.
Nous sommes en collant avec une version plus ancienne de RoboHelp. Les fichiers sont au format html standard tarif, donc il fonctionne bien avec le contrôle de version.
OriginalL'auteur Hemant
DocBook
le texte d'alt http://www.docbook.org/graphics/banner.png
Il est Épique Éditeur (ptc.com/products/arbortext-editor) mais c'est cher et pas très puissant.
Xmlmind a une sorte de visual editor. Ce n'est probablement pas WYSIWYG, mais là encore, dans de nombreux cas, vous ne pas vous voulez WYSIWYG de toute façon, vous voulez Ce que Vous Obtenez Est Ce que Vous Voulez.
DocBook sépare complètement de la structure du contenu, de sorte que l'idée d'un éditeur WYSIWYG n'a tout simplement pas de sens du tout - c'est une impossibilité logique. Personnellement, j'aime DocBook, mais j'ai trouvé que beaucoup de gens il suffit de ne pas " get " l'idée de la création de documents structurés - ils peuvent penser seulement en termes visuels. Ces personnes sont généralement réticents à l'aide de DocBook et faire un désordre complet de la structure parce qu'ils essaient de faire quelque chose qui ressemble à droite " sur la page.
Goldy je ne suis d'accord j'ai utilisé Docbook pour un projet parce que j'ai aimé la façon dont vous avez spécifié la structure, mais il était très difficile d'écrire le texte directement dans le document xml, il n'était pas jusqu'à ce que le html final a été généré que je puisse voir les erreurs que j'avais fait. Je ne vois aucune raison pourquoi vous ne pouvez pas avoir un éditeur WYSIWYG qui a sauvé la doc comme docbook xml fichier parce que la plupart des éléments docbook ont un synonyme elemt dans un éditeur WYSIWYG ie <headng1> -> <sect1> . Docbook ne pas séparer la structure de contenu, à la fois dans le même document,ce qu'il fait est de séparer la structure de la façon dont la structure est réalisé.
OriginalL'auteur prakash
Microsoft HTML Help Workshop peut être utilisé pour créer de bons professionnels de qualité des fichiers d'aide CHM. Tous vous avez besoin est d'un tas de fichiers HTML. L'outil "compile" toutes ces bottes en un seul fichier d'Aide.
Les fichiers HTML peuvent être générés à l'aide de Microsoft Word/Frontpage ou encore Dreamweaver. Vous pourriez envisager de la source de contrôle de ces fichiers HTML.
Devinez 2008 n'est pas toute des bars...
OriginalL'auteur Nikhil Kashyap
Latex. Lyx fournit WYSIWYM pour l'écriture de fichiers latex.
Vous aurez beau temps pour produire autre chose que PDF/PS de LaTeX.
OriginalL'auteur grom
À mon ancien poste, ils ont utilisé un outil par madcap logiciel appelé fusée.
Il semble fonctionner très bien.
OriginalL'auteur Omar Kooheji
Une bonne combinaison à prendre en compte est la Subversion, DocBook et le Publicain.
Pour le moment, c'est l'un des toolchains en cours d'utilisation par le plus grand fournisseur mondial de solutions open source, et derrière ce nom se cache une grande partie du monde de l'utilisation de Linux systèmes d'exploitation dans le marché de l'entreprise. La plupart (et à proximité de tous) de Red Hat, la documentation officielle est créé de telle manière. En va de même pour Fedora.
Les principaux "pro" ici, c'est que ces conditions sont disponibles gratuitement outils, avec un chevauchement important dans le marché des rédacteurs techniques. Tout ce qui pourra (mais ne le voulons pas) écrire en XML, et de ramasser DocBook est comme la cueillette du code HTML dans les années 90. Subversion est un outil de contrôle de version, que, comme DocBook est relativement facile à mettre en œuvre et à utiliser. Publicain est un excellent outil de publication qui peut prendre DocBook XML, et de le publier au format PDF, HTML, HTML célibataires, etc. Evidemment, vos écrivains pouvez utiliser un WYSIWYG comme Serna, mais j'utilise des extraits dans Geany (sur Fedora) ou TextMate (sous OS X) personnellement.
Les principaux "con" est la perception de la technicité. Votre les écrivains veulent WYSIWYG (et peut), et en fonction de vos besoins de documentation, ce pourrait être ce que vous utilisez en fin de compte. Comme vous le savez, il y a un marché pour les "Rédacteurs Techniques" qui se spécialisent dans la fixation de Microsoft Word styles (et de balisage), de sorte que les arguments en faveur de la séparation "de création" à partir de "publication" sont basés sur des méthodes éprouvées, mais distincts des cas d'utilisation pour les organisations qui exigent de la documentation être tenus aux mêmes normes de l'ingénierie/programmation/source de production.
Certains de l'extrême conseils, vous obtiendrez vient de personnes et d'entreprises qui ont été exposés à la valeur de la documentation XML, et en particulier ceux dans les domaines de DITA, où certaines multinationales ont une réputation pour des acquisitions qui sont influencés par le format et la disponibilité de la connaissance des produits. il y a aussi les arguments que le verrouillage de votre documentation dans un "post-it" ou fermée format n'aide pas l'avenir, les exigences d'entretien. C'est là que l'open source les options obtenir un appui sur un niveau de l'entreprise. De Plus, évidemment, c'est gratuit.
OriginalL'auteur ddri
Vous pouvez utiliser Subversion et MGTEK Aider Producteur. Aider les Producteurs de l'aide de fichiers à partir de documents Word. TortoiseSVN est livré avec des scripts afin de comparer les différentes révisions de documents Word, dans le Mot lui-même (Word a une version outil de comparaison).
Vos utilisateurs vont vouloir un visual diff outil qui ressemble à celui qu'ils sont d'édition. Si ils sont juste légèrement non-technique, DocBook ou en Latex ne sont pas en train de travailler (j'ai essayé de donner à mes utilisateurs à la fois, et j'ai même essayé de Épique de l'Éditeur comme un DocBook éditeur qui est très coûteux mais cela ne fonctionnait pas très bien, après tout). Coller à quelque chose qu'ils connaissent (Word) vous évitera bien des maux de tête.
J'ai été très réticents à aller dans cette voie au premier abord trop, parce que je voulais une solution plus "techniquement parfait", mais j'ai réalisé plus de temps que d'avoir des heureux et productifs, les utilisateurs de plus en plus important. Juste pour dire que je sais d'où vous venez, mais essayez de la Parole de route il fonctionne beaucoup mieux, en pratique, que tous les "pure" texte basé sur des solutions qui sont là-bas. Les utilisateurs réguliers n'aime pas balisage en fonction d'édition.
Eh bien, vous pourriez mettre en place des styles dans Word et demandez à vos utilisateurs de l'utiliser. Aider les Producteurs des cartes de Mot de styles CSS (vous pouvez définir cette cartographie vous-même). De cette façon, le "maître formateur" a le pouvoir de changer le CSS dans un emplacement central. Vos utilisateurs ont à utiliser des styles pour faire ce travail.
+1 ne savais pas TortoiseSVN intègre avec Word, thx
OriginalL'auteur Roel
Si vous utilisez Visual Studio, prendre un coup d'oeil au château de sable - http://www.codeplex.com/Sandcastle.
Il y a aussi quelques outils qui vous aident à construire des châteaux de sable de fichiers, essayez de chercher "château de sable" sur codeplex. L'un d'eux est SandCastle Help File Builder (http://www.codeplex.com/SHFB), mais je n'ai jamais utilisé donc je ne sais pas si les utilisateurs non-techniques seront heureux.
C'est vrai, mais vous pouvez également inclure du code html arbitraire. Et le fichier d'aide du générateur est plus liée à la question. Mais avec le recul, il est exact que ce n'est pas une solution complète au problème.
OriginalL'auteur stombeur
Mapcap Flare est le meilleur outil commercial autour de. Écrit par l'ex-développeurs de Robodoc
OriginalL'auteur woany
J'ai créé un système de documentation appelé Mandown (Markdown/Html/Javascript/fichier de la base de relativement documents liés pour la portabilité) qui pourrait facilement aller sous contrôle de version. L'éditeur visuel de la partie vous devez comprendre séparément, j'utilise parfois HTML-Kit qui au moins a une fonction de prévisualisation.
Voir Quelle est la meilleure façon de conserver la documentation du logiciel?
Voici un autre outil pour vérifier: Xilize
OriginalL'auteur micahwittman
Nous utilisons APT. Il s'intègre bien avec l'IC (version standard de l'artefact) et est plus vivant que par exemple un document word. Il est également possible de générer des fichiers Pdf et d'autres formats en cas de besoin.
OriginalL'auteur Petr Macek