Версия для печати темы
Нажмите сюда для просмотра этой темы в оригинальном формате
Форум программистов > Клуб юнуксоидов > Документирование информационной системы


Автор: mihanik 8.1.2012, 19:55
Всем привет!

Информационная система в моей фирме постоянно усложняется.
Иногда берём на обслуживание информационные системы у наших клиентов.
Всё упомнить невозможно.
Появилась потребность как-то централизованно вести базу по тому что, где и как настроено.
В текстовом файле это вести не удобно.
Кто и как решает такие проблемы?

Автор: mihanik 9.1.2012, 22:18
Буду использовать http://www.dokuwiki.ru/


Автор: ToshaCh 12.1.2012, 17:32
Сам этим вопросом мучаюсь. Понятно, что нужна wiki, однако почти у всех вики есть один существенный недостаток: отсутствие структур. Т.е. я не могу по человечески сделать оглавление. Для wikipedia.org это годится - такова модель работы, а для внутреннего технического сайта это не удобно. 

Автор: bilbobagginz 13.1.2012, 09:32
ToshaCh, убил ты меня, наповал. что значит нет структуры ?!
практически все вики поддерживают шаблонирование. и большинство новых имеют WYSIWYG редакторы.
осталось натравить верстальщика на CSS результирующих док, и они будут иметь не просто "организованный", 
но и опрятный и даже стилизованный под организацию вид. 
причем разные css могут идти в зависимости от устройства вывода (дисплей, принтер, и т.д.)

кроме того, те вики, которые написаны на нормальном ЯП можно подкручивать, добавлять расширения, макро и т.д.
я напр. пользуюсь сейчас http://moinmo.in.

у нас нередко идут ссылки на баги/задачи из jira. было надо сделать возможность выстро линковать в них.
нарисовал macro за 15 минут (вкл. тестирование), пишешь в строке:
Код

<<JiraIssue(ID)>>

и после сохранения документа появляется ссылка на правильный сервер, на багу (удобно доки релизов готовить).
если бы пакет jira был поновей, можно было через XML-RPC API вытащить целый запрос на этот isssue - на ком висит, каков статус и т.д.

все это еще и документировано.
мне кажется "вы их не умеете готовить"


Автор: ToshaCh 13.1.2012, 15:43
Речь не про внутреннюю структуру отдельного документа, а про структуру хранения документов (здесь структура это общность документов). Вики реализуют в первую очередь идею "базар" разработки, когда реализуется паутина документов. А мне нужна иерархическая структура страничек, опционально можно с тегами. При этом, важна возможность управлять структурой как единым целым, желательно с версионностью всей структуры (так было бы удобно разрабатывать документацию к проекту). 

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

Автор: mihanik 13.1.2012, 16:53
докувики мне понравилась структурированностью, безопасностью (на каждый отдельный документ или пространство имён могу дать разрешения или группе иди пользователю такие, какие хочу).
И ещё!
Я не использую БД. Все статьи хранятся в виде обычных текстовых файлов.
Там много вкусностей...

smile

http://s2.ipicture.ru/Gallery/Viewfull/7931469.html

Автор: mihanik 14.1.2012, 08:42
bilbobagginz, 
по поводу MoinMoin.
Посмотрел я на неё. Не вьехал. 

Powered by Invision Power Board (http://www.invisionboard.com)
© Invision Power Services (http://www.invisionpower.com)