Формат написания инструкции

nezabor
На сайте с 19.07.2010
Offline
152
377

Уважаемые господа,

с недавнего времени нашей компании было принято решение о написании инструкции по работе с нашим ПО. Все было бы просто, но проблема в том, что мы за 10 лет работы имеем ++1к релизов, фичей, багов, модулей и иже с ними.

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

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

Собственно есть предложение писать инструкцию на wiki, но тут тоже не все так просто. Писать/изменять сразу в нескольких местах архи неудобно.

ВОПРОС:

есть ли у wiki возможность написания контента для определенного пользователя(ей), т.е. определенный пользователь видит определенные надписи.

Кроме того, может кто поделится как он ведет документацию проектов?(интересует описание пользовательского/административного ф-ционала)

На данный момет не совсем полная документация продукта больше 150 страниц(в рамках одного клиента)

Чудес не бывает...
IL
На сайте с 20.04.2007
Offline
435
#1
nezabor:
Писать/изменять сразу в нескольких местах архи неудобно.

Контроль версий.. git в помощь.

txt-файлики в markdown-формате, лёгким движением руки превращаются в HTML (или в кучу других форматов)

Да и в wiki-движках есть возможность отслеживать историю изменений.

... :) Облачные серверы от RegRu - промокод 3F85-3D10-806D-7224 ( http://levik.info/regru )
nezabor
На сайте с 19.07.2010
Offline
152
#2

ivan-lev, да, про историю изменения я в курсе. исрория изменения ведется в рамках одного документа, а представьте что один и тотже изначальный доркумент помножен на количество клиентов и у каждого есть свои ветви изменения данного документа. Если хранить изменения в рамках одного документа то тогда нужен грамотный инструмент деления истории по правам пользователей, чтобы 1 клиент не видел изменения другого клиента(критично).

---------- Добавлено 07.02.2014 в 18:09 ----------

И именно я пока не могу придумать такой инструмент

IL
На сайте с 20.04.2007
Offline
435
#3
nezabor:
грамотный инструмент деления истории по правам пользователей, чтобы 1 клиент не видел изменения другого клиента(критично).

У wiki движков есть условный вывод контента.

https://www.dokuwiki.org/plugin:showif

https://www.dokuwiki.org/plugin:ifauth

при необходимости - допиливать.

nezabor
На сайте с 19.07.2010
Offline
152
#4

ivan-lev, второй по списку ближе к теме

СПС зап помощь

Авторизуйтесь или зарегистрируйтесь, чтобы оставить комментарий