|
Ведение документации несколькими разработчиками одновременно
|
|||
---|---|---|---|
#18+
Люди, как реализовать субж? Два дня поиска в инете не дали ответа. Может кто сталкивался с подобной задачей? Необходимо вести документацию по программному продукту. И в написании участвует небольшой коллектив (2-5 человек). Необходимо синхронизировать работу так, чтобы изменения одного из редакторов попадали в общее хранилище и другие редакторы могли подтягивать эти изменения в свои редактируемые документы. Параллельно нужно организовать ссылки между документами. Формат файла справки пока еще не определен до конца, либо это chm, либо pdf, либо html. Либо сочетание второго и (первого или третьего). Хорошо бы еще привязать систему контроля версий сюда. Минус существующих редакторов справок (типа Help & Manual, HelpCruiser) - в том что они используют собственные внутренние форматы и в конечные файлы справок (chm, hlp, pdf, rtf, xml...) преобразуют как экспорт из своего внутреннего формата. При таком подходе трудно организовать ведение документации сразу несколькими редакторами, с этим файлом может работать один человек одновременно. Если бы был удобный редактор, в котором внутренний формат был xml или html - задача бы упростилась... В общем, ищется система для субжа! ... |
|||
:
Нравится:
Не нравится:
|
|||
27.06.2005, 18:20 |
|
Ведение документации несколькими разработчиками одновременно
|
|||
---|---|---|---|
#18+
Чем не устраивает идея использовать любой HTML- либо вообще текстовый редактор? А для организаций коллективной работы использовать любую систему контроля версий. Например CVS, VSS, Team Coherence и т.п. Posted via ActualForum NNTP Server 1.2 ... |
|||
:
Нравится:
Не нравится:
|
|||
27.06.2005, 18:38 |
|
Ведение документации несколькими разработчиками одновременно
|
|||
---|---|---|---|
#18+
В существующих системах сооздания справки (упомянутых выше, и вообще их еще много в мире) работа производится непосредственно с содержательной частью, не надо знать теги, не надо знать как создается таблица посредством этих тегов и т.д., работа идет как в несколько видоизменном тесктовом редакторе типа worda. Это плюс. Народ, который пишет документацию он самим программированием не занимается и обучение тем же самым тегам - на это нужно время, которого нету. Нужна либо программа создания документации/справки, внутренним форматом которого будет текстовый файл (типа html) - тогда можно будет использовать CVS, VSS и т.д., либо нужна такая программа или средство (может Wiki?, знаком поверхностно) которое создает ту же справку с интегрированной возможностью коллективной работы. Под документацией/справкой подразумевается документация, которая обычно поставляется с программными продуктами, когда слева - фрейм навигации (раздел, индексный поиск и просто поиск), а справа - фрейм с самой справкой, в которой поддерживаются перекрестные ссылки. Просто нужно быстро найти хоть какое-нибудь решение. ... |
|||
:
Нравится:
Не нравится:
|
|||
27.06.2005, 19:21 |
|
Ведение документации несколькими разработчиками одновременно
|
|||
---|---|---|---|
#18+
Я у себя сделал такую систему: 1. Топики хранятся в БД в виде RTF (туда достаточно легко вставляются любые рисунки; нормальые возможности форматирования) 2. Топики разбиты на группы, папки 3. На каждый топик можно создать "ответ" (в виде RTF) - как в форумах 4. При просмотре: слева - фрейм навигации как в хелпах; справа - отображаемый RTF 5. При создании топиков и ответов - они индексируются по словам - в "предметном указателе" - при выборе слова выдается список топиков, гед оно употребляется. 6. Имеется таблица "See also" (см. также) - очень удобная фенька! 7. Имеется обычный поиск 8. Топики пронумерованы - удобно для общения и поиска 9. На каждый раздел можно назначать права доступа просмотра/редактирования 10. Система была приспособлена под "Сбор пожеланий юзеров" 11. Система была приспособлена под "Управление проектами" 12. Система была приспособлена под "Учет исполнения пожеланий" P.S. Можно просто Бизик admin@busyman.ru ICQ# 131833549 ... |
|||
:
Нравится:
Не нравится:
|
|||
27.06.2005, 19:50 |
|
Ведение документации несколькими разработчиками одновременно
|
|||
---|---|---|---|
#18+
Здорово, когда такая система есть и ее кто-то ведет, настраивая под нужды организации. А экспорт в стандартные файлы справки типа сhm, html, pdf... у нее есть? Нужно чтобы формировалась инструкция пользователя в стандартном формате, такой чтобы юзер легко мог прочитать у себя на машине. Сколько делали такую систему, на чем? Интересуют с той целью, что может быть придется также свою писать. Вопросы остались по вашей системе. Может не стоит в этой ветке, но ладно уж... интересно. - RTF-файлы - вообще-то много места занимают. Не тормозит и не пухнет база? - Как подобная система может быть приспособлена под управление проектами? (пусть хоть и для вашей организации) ... |
|||
:
Нравится:
Не нравится:
|
|||
27.06.2005, 20:23 |
|
Ведение документации несколькими разработчиками одновременно
|
|||
---|---|---|---|
#18+
Ответ однозначен: только DocBook, см. docbook.ru . Искать надо было лучше :) ... |
|||
:
Нравится:
Не нравится:
|
|||
28.06.2005, 11:45 |
|
Ведение документации несколькими разработчиками одновременно
|
|||
---|---|---|---|
#18+
АБОтвет однозначен: только DocBook, см. docbook.ru. Искать надо было лучше :) Спасибо за информацию! А ищем как можем; вот до этой ветки форума добрался, глядишь и не зря :) ... |
|||
:
Нравится:
Не нравится:
|
|||
28.06.2005, 17:27 |
|
|
start [/forum/topic.php?fid=33&msg=33139017&tid=1549601]: |
0ms |
get settings: |
8ms |
get forum list: |
15ms |
check forum access: |
4ms |
check topic access: |
4ms |
track hit: |
152ms |
get topic data: |
13ms |
get forum data: |
3ms |
get page messages: |
53ms |
get tp. blocked users: |
2ms |
others: | 14ms |
total: | 268ms |
0 / 0 |