Что является хорошим инструментом для записи руководства пользователя (справочного файла), который интегрируется с [закрытым] управлением версиями
Если вы также хотите их сортировать на странице
$('div[id^="pi_div"]').sort(function (a, b) {
var re = /[^\d]/g;
return ~~a.id.replace(re, '') > ~~b.id.replace(re, '');
})
.appendTo("#container");
Обратите внимание на ~~, который преобразует значения в целые числа, иначе они будут сравниваться как строки.
10 ответов
Существуют другие профессиональные продукты, которые позволяют запись справочного файла, и у них есть поддержка "идентификатора контекста", который делает контекстно-зависимую справку возможной. Документ Для Помощи и RoboHelp подобные продукты.
В моем старом задании они использовали инструмент сумасбродным программным обеспечением, названным вспышка .
Это, казалось, работало действительно хорошо.
Microsoft HTML Help Workshop может использоваться для создания профессионала хорошего качества справочные файлы CHM. Все, в чем Вы нуждаетесь, является набором файлов HTML. Инструмент "компилирует" все они и связывается в единственный Справочный файл. Файлы HTML могут быть сгенерированы с помощью Microsoft Word / Первая полоса или даже DreamWeaver. Вы могли бы хотеть рассмотреть источник, управляющий этими файлами HTML.
Вспышка Mapcap является лучшим коммерческим инструментом вокруг. Записанный экс-разработчиками Robodoc
Я создал систему документации, названную Mandown (, Markdown/Html/Javascript/file-based относительно связал документы для мобильности), который легко пойдет при управлении версиями. Визуальная часть редактора, которую необходимо было бы выяснить отдельно - я иногда, использует Набор HTML , который, по крайней мере, имеет функцию предварительного просмотра.
Видят , Что лучший способ состоит в том, чтобы сохранить документацию программного обеспечения?
<час>Вот другой инструмент для проверки: Xilize
Если Вы используете Visual Studio, смотрите на SandCastle - http://www.codeplex.com/Sandcastle .
существует также несколько инструментов, которые помогают Вам создать файлы замка из песка, попытаться искать "замок из песка" на codeplex. Один из них является Разработчиком Справочного файла SandCastle ( http://www.codeplex.com/SHFB ), но я никогда не использовал его так, я не знаю, будут ли нетехнические пользователи довольны этим.
Мы используем APT. Это интегрируется хорошо с CI (стандартный артефакт сборки) и более живо, чем, например, документ слова. Также возможно генерировать PDFs и другие форматы при необходимости.
Можно использовать Подверсию и Производителя Справки MGTEK. Производитель справки делает справочные файлы из документов Word. TortoiseSVN идет со сценариями для сравнения различных изменений документов Word, в самом Word (Word имеет версию, сравнивают инструмент).
Ваши пользователи собираются хотеть визуальный различный инструмент, который напоминает тот, в котором они редактируют. Если они просто немного не - технические, DocBook или Латекс не собираются работать (я попытался дать моим пользователям обоих, и я даже судил Эпического Редактора как редактора DocBook, который является очень дорогим, но не удался очень хорошо, в конце концов). Придерживание чего-то, что они знают (Word), предотвратит Вас много головных болей.
я очень отказывался пойти этим путем сначала также, потому что я хотел решение, которое было больше 'технически прекрасным', но я понимал со временем, что наличие счастливых и продуктивных пользователей было более важным. Просто высказывание, что я знаю, куда Вы происходите из, но пробуют маршрут Word - он работает намного лучше на практике, чем все 'чистые' основанные на тексте решения, которые являются там. Обычным пользователям не нравится основанное на разметке редактирование.