Как использовать Subversion с HelpNDoc

Question

Как использовать Subversion с HelpNDoc

Я пишу документацию для проекта, в котором участвуют несколько разработчиков. Мы используем Subversion (SVN) для работы с нашей кодовой базой.

Я написал первый черновик документа документации, используя HelpNDoc, который мне нравится за красивое древовидное представление и простоту использования; проблема в том, что существует один файл, поэтому я не знаю, как использовать SVN, чтобы другие разработчики могли вносить свой вклад в документацию и обновлять ее.

Вы знаете, возможно ли это? Если нет, можете ли вы посоветовать хорошее программное обеспечение, простое в использовании, с древовидным представлением документации, которая может использоваться с SVN, или позволяет нескольким пользователям обновлять ее? Мы используем Windows.

3

windows svn documentation software-quality helpndoc

Источник

user465159 09 сен '16 в 10:39

3 ответа

Другие вопросы по тегам windows svn documentation software-quality helpndoc

user184404 21 сен '16 в 08:47 2016-09-21 08:47 · Answer 1 · 2016-09-21 08:47

Проекты HelpNDoc - это двоичные файлы, основанные на ядре базы данных с открытым исходным кодом SQLite. Преимущество заключается в том, что вся документация хранится в одном файле, поэтому ее можно легко скопировать, переместить, совместно использовать, создать резервную копию... Однако одним из недостатков является то, что ее необходимо регистрировать как двоичный контент в любой системе контроля версий, включая Subversion: diff и объединение невозможно в этих файлах.

Одним из возможных решений было бы использование внешних документов в библиотеке HelpNDoc: каждый пользователь работает над своим собственным документом (который может быть документом Word и веб-страницей HTML...), и создается главный проект HelpNDoc для включения этих документов при генерации время. См. "Включение файла во время генерации" в следующем пошаговом руководстве: Как добавить элемент в библиотеку

user6816663 10 сен '16 в 12:10 2016-09-10 12:10 · Answer 2 · 2016-09-10 12:10

Я когда-то использовал Helpinator для документации программного обеспечения, он довольно близок к HelpnDoc, но его формат хранения больше подходит для контроля версий.

1

Источник

user6816663 10 сен '16 в 12:10

user960558 09 сен '16 в 12:41 2016-09-09 12:41 · Answer 3 · 2016-09-09 12:41

Количество файлов не имеет значения, реальный формат (текстовый /* или двоичный) - имеет значение. Если SVN| любая VCS может объединить два файла HelpNDoc с разнородной историей (попробуйте вручную), вы будете счастливы

0

Источник

user960558 09 сен '16 в 12:41