Wiki-подобный инструмент для написания спецификаций и документации [закрыто]

9

Я ищу вики или подобную вики систему для написания и управления спецификацией и документацией для программного проекта.

Я знаю, что существует множество вики-реализаций, но есть ли такие, которые особенно хорошо подходят для такого рода задач?

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

user35746
источник
1
Вы используете специальную платформу? Например, TFS от Microsoft?
Саид Нимати
В соответствии с тем, что спросил @Saeed, какие виды инфраструктуры уже есть в вашей команде / организации для управления знаниями и обмена ими? Кроме того, каковы ваши текущие процессы для написания спецификаций и документов?
Томас Оуэнс

Ответы:

6

Мы используем LaTeX и SVN. Поскольку документы LaTeX - это просто текстовые файлы, он хорошо работает с контролем версий, в отличие от некоторых двоичных или частично двоичных форматов.

Вы получаете все преимущества (и недостатки, по общему признанию) контроля версий, к которому вы привыкли, используя его с вашим кодом.

LaTeX требует небольшой настройки (для определения ваших собственных стилей / классов), но как только вы это сделаете, это очень хорошо - вы можете сосредоточиться исключительно на контенте, а не на его презентации (вместо того, чтобы испытывать соблазн постоянно подстраиваться, как вы с WYSIWYG), но в конце все равно получите гладкий, профессионально выглядящий PDF-документ.

Скотт
источник
4

Лично мне очень нравится Tiddly Wiki .

Он имеет довольно полный синтаксис вики, представляет собой отдельный HTML-файл и хорошо работает с различными веб-браузерами без необходимости использования сервера.

Он даже имеет расширяемую архитектуру плагинов, которая позволяет добавлять плагины для выполнения всевозможных интересных вещей, таких как шифрование тиддлеров или добавление сносок.

Марк Бут
источник
3

Для платформы Microsoft интеграция TFS (Team Foundation Server) с SharePoint - это именно то, что вы ищете. Создав новый командный проект, вы можете выбрать шаблон, охватывающий практически все аспекты процесса разработки программного обеспечения. Он предоставляет вам портал, на котором вы можете определять членов команды, назначать их роли и разрешения безопасности, загружать, обмениваться и редактировать документы и спецификации, относящиеся к вашему проекту, и делать с ним много других интересных вещей.

Для других платформ, я думаю, вы можете использовать что-то вроде GitHub (хотя я не уверен в этом).

Саид Нямати
источник
0

Для личного проекта (существующего только на моем ПК) я использую вики в банке . В прошлом я работал с Redmine (кроме того, у него есть система отслеживания ошибок и SCM)

alepuzio
источник
0

Вы можете попробовать Sphinx с документами, проверенными в выбранной вами инфраструктуре управления исходным кодом. Это имеет преимущества управления исходным кодом и относительно легкого языка разметки reStructuredText , который прост в изучении и довольно хорошо приспособлен для преобразований (в HTML, в PDF и т. Д.).

asthasr
источник