powered by simpleCommunicator - 2.0.51     © 2025 Programmizd 02
Форумы / Разработка информационных систем [игнор отключен] [закрыт для гостей] / Документирование существующей ИС
25 сообщений из 140, страница 1 из 6
Документирование существующей ИС
    #34089635
bebop
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
Есть самописная информационная система, одной торговой компании - ей (ИС) уже около 10 лет. Система достаточно велика, чтобы никто в отделе, не знал её полностью.

Сейчас описано и поддерживается в актуальном состоянии только назначение таблиц и полей в БД (процентов на 70-80).
Остальное описание системы предсталяет из себя разрозненные документы (описание отдельных бизнес-процессов, проектная документация по некоторым фичам, описание отдельных отчётов итд итп).
Много функционала вообще нигде не описано.

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

Интересно именно описание требований к системе, а не описание реализации. Т.е. по любой фиче в системе, любой разработчик, аналитик или тестер (а возможно и пользователь?) должен легко получить исчёрпывающую информацию о том для Чего и для Кого Это делалось и как Это должно себя вести.
Соответственно, когда делается новый проект любому было понятно, что в описании надо изменить, чтобы оно осталось актуальным.

Ещё одно ограничение: описание должно быть максимально постепенным, т.е. сразу всё описать по ресурсам не получится. Описание будет происходить несколько месяцев, практически в фоновом режиме.

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



* ARIS?
Сам я не специалист, но то что я видел разочаровало. Попытка писать в нём (не мной :) а специалистами) детальные требования к системе приводили к жутким макаронным диаграммам, где ничего не понятно.

* Написать ОченьБольшуюSRS
Возможно ещё ОченьБольшоеОписаниеВсехЮзКейсов ?
и Концепцию листов так на 80-100 ?

* Завести внутренний вики-ресурс ?
Опять таки вопрос,какая должна быть структура у этого ресурса

* Requisite Pro?

* Другие инструменты?
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34089773
Фотография grexhide
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
bebop
* Другие инструменты?

а) забить

б) внедрить другую систему с готовой документацией ;))))
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34089781
Фотография grexhide
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
bebopДумаю, задача, мягко говоря, не нова.


Задача, мягко говоря, глупа. Как правило - никогда не возникает таких задач, как переписать все глобально.

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

Отдельно - для пущей подстраховки в случае сильной переделки - реализуются интеграционные интерфейсы, по сути - VIEW. Исключительно для целей совместимости и плавного перехода в случае сильной переделки системы.

Но никому и не нужно описание ВСЕЙ системы в целом и в подробностях реализации, важны - лишь - интеграционные моменты. Программистам - так тем более - это всеобщее описание - чаще как зайцу стоп сигнал. Или банально, или не понятно. В любом случае - бесполезно.

----

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

А если софт изначально настолько бардачный и лапшеобразный - то и описать его не получится, и развивать - уж тем более. Действительно - проще будет внедрить новую систему в виде реинжиниринга и модернизации (если цель поставить - наведение порядка, и требование - тщательное документирование всего и вся).
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34089998
Фотография Гликоген
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Такое описание ИС имеет смысл. ИС переросла ее разработчиков и вышла на уровень Компании. Теперь люди могут меняться (и меняются), а ИС развивать надо. Кстати, если будет решение о смене ИС, то полная документация по существующей сильно поможет. Хотя бы тем, что будут люди, знающие AS IS.

Итак, я бы сделал в Access или другой подходящей среде быстрой разработки ИС для документирования ИС.
В виде нескольких сущностей, реляционно связанных между собой, и простеньких форм, обеспечивающих ввод/правку.
Сущности, навскидку -
1.объект ИС с типом, заказчиком, другими свойствами, возможно, документацией и списком других используемых/вызываемых объектов в этой же ИС.
2.БП, или функция, реализованная в ИС - в виде отнумерованного списка объектов, опять же, с заказчиком - последовательность выполнения.
Учитывая возможные ветвления, можно аттачить стандартные блок-схемы на одном из стандартных языков описания БП.
3.персоналии - справочник заказчиков, исполнителей функций и объектов
4.запрос на изменение (он же requirement) - суть запроса, заказчик, кому поручено, реализовано кем/когда

Из такой ИС можно будет при должном старании генерить документацию в любом требуемом формате.
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34090318
bas
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
bebop* Написать ОченьБольшуюSRS
Возможно ещё ОченьБольшоеОписаниеВсехЮзКейсов ?
и Концепцию листов так на 80-100 ?

Я бы сделал именно так. Но только привязал бы к каждому ВИ отдельный сценарий (документ или диаграмму) и поддерживал бы актуальность на уровне каждого сценария ВИ. Но, единственное, что из Розы у меня не получилось сгенерить единый документ на основе привязанных документов, возможно, что это умеет делать РеквизитПро.
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34090524
andbary
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
bebop Когда я сам, сталкнулся с подобной проблемой, быстро выяснилось, что:
1. Трудоемкость документирования сравнима с написанием новой системы.
2. Перед данным действом необходимо навести порядок, иначе придеться документировать "кучу мусора".
3. Проверить правильность документации не представляется возможным.

Я пошел по пути "уборки мусора"... До сих пор убираю

PS Документировать можно только основные процессы, все остальное в вашей ситуации не имеет смысла.
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34090588
Фотография Petro123
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
andbary bebop Когда я сам, сталкнулся с подобной проблемой, быстро выяснилось, что:
1. Трудоемкость документирования сравнима с написанием новой системы.
2. Перед данным действом необходимо навести порядок, иначе придеться документировать "кучу мусора".
3. Проверить правильность документации не представляется возможным.

Я пошел по пути "уборки мусора"... До сих пор убираю

PS Документировать можно только основные процессы, все остальное в вашей ситуации не имеет смысла.
+1
- обычно "полное описание" надо при уходе "главного специалиста" .
- поддержание порядка "в голове" или "на бумаге" бОльшой системы зависит от качества характера и ... желания руководства.
Т.е.
идти от "уборки мусора"... и ввести простейший Bug Tracker (напр. Mantis) .
Очень удобно слушать "мнения пользователей".
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34091795
alex108
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
Ситуация несколько похожа... Формализовать существующие процессы "уже поздно", но система работает и поэтому проблема документации актуальна.

Пытаюсь использовать локальную wiki-документацию (pmWiki). Наполнение происходит постепенно и постоянно.
Документы привязаны к подсистемам и режимам с online-доступом. Документация пишется как для пользователя, так и для разработчика (на случай доработки).
То есть структура системы сама диктует структуру документации.

Есть "самописный" bug tracking, который тоже интегрируется с wiki.
Вообщем, пока очень даже устраивает...
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34092225
Alexey Kudinov
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
bebopЕщё одно ограничение: описание должно быть максимально постепенным, т.е. сразу всё описать по ресурсам не получится. Описание будет происходить несколько месяцев, практически в фоновом режиме. Если это на деле означает, что задача по описанию возлагается на программистов или тестировщиков или ... как дополнительная нагрузка, то я практически уверен, что ничего у вас не получится (в лучшем случае "отмазка" для руководства).

У нас когда-то чем-то аналогичным занимался специально выделенный человек и это было одной из его должностных обязанностей.
При этом
- код изначально был отлично документирован.
- люди, которые "знают все" были доступны.
Как результат, был описан основной функционал и взаимосвязи в системе. Но далеко не все.
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34092693
bebop
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
grexhide
...никогда не возникает таких задач, как переписать все глобально...
...для пущей подстраховки в случае сильной переделки - реализуются интеграционные интерфейсы...
...Программистам - так тем более -.... Или банально, или не понятно...

Вы не совсем о нашей ситуации говорите.

Постараюсь проиллюстрировать примером:
*Делаем Проект111 для бухгалтерии, одновременно хорошо описали несколько юз-кейсов и бизнес-правил о том как отдел закупки работает с таможней.

*Прошло полгода. Аналитик проекта111 уволился. Делаем проект222 для отдела закупок. Никому в голову не придёт искать что-то в проекте111. Всё требования начинаем писать с нуля.

*Прошёл год. Делаем проект111версия2. Тремя месяцами раньше в ходе реализации проекта 150 для фронт-офиса фичи по проекту111 подкорректировали. Информация об этом только в документации по проекту 150. Кроме этого по просьбе пользователей сделали 4 небольших доработки по проекту111. Информация об этом есть только в баг-трекере. Результат: собираем требования для проекта111версия2 практически с нуля.


Если конкретизировать, то основные потребители такой документации - аналитики.
Основная цель: повторное использование требований к ПО.
Ищется инструмент и\или методика.

Цели тотального отслеживания что на что влияет не стоит. Для этого есть методы уровня разработчиков.

Возможно есть цель иметь некий классификатор функционала, чтобы программисты могли на него ссылаться. Здесь я не очень уверен, покритикуйте.
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34092695
bebop
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
Гликоген
Итак, я бы сделал в Access или другой подходящей среде быстрой разработки ИС для документирования ИС.
В виде нескольких сущностей, реляционно связанных между собой, и простеньких форм, обеспечивающих ввод/правку....
alex108
Есть "самописный" bug tracking, который тоже интегрируется с wiki.
Вообщем, пока очень даже устраивает...
Petro123
идти от "уборки мусора"... и ввести простейший Bug Tracker (напр. Mantis) .
Очень удобно слушать "мнения пользователей".
Баг трекер есть. Не помогает. Цель немного другая. (См. постом выше)
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34092700
bebop
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
andbary Когда я сам, сталкнулся с подобной проблемой, быстро выяснилось, что:
1. Трудоемкость документирования сравнима с написанием новой системы.
2. Перед данным действом необходимо навести порядок, иначе придеться документировать "кучу мусора".
3. Проверить правильность документации не представляется возможным.
Я пошел по пути "уборки мусора"... До сих пор убираю
PS Документировать можно только основные процессы, все остальное в вашей ситуации не имеет смысла. alex108...
Пытаюсь использовать локальную wiki-документацию (pmWiki). Наполнение происходит постепенно и постоянно.
Документы привязаны к подсистемам и режимам с online-доступом. Документация пишется как для пользователя, так и для разработчика...
Alexey Kudinov...
У нас когда-то чем-то аналогичным занимался специально выделенный человек и это было одной из его должностных обязанностей.
При этом
- код изначально был отлично документирован.
- люди, которые "знают все" были доступны.
Как результат, был описан основной функционал и взаимосвязи в системе. Но далеко не все. Petro123... поддержание порядка "в голове" или "на бумаге" бОльшой системы зависит от качества характера и ... желания руководства.
Т.е. идти от "уборки мусора"...
Очень удобно слушать "мнения пользователей".Как вы думаете цель повторного использования ранее собранных требований реалистична? Возможно это утопия на любом инструментальном средстве?
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34092717
Фотография grexhide
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
bebopВозможно есть цель иметь некий классификатор функционала, чтобы программисты могли на него ссылаться. Здесь я не очень уверен, покритикуйте.

Дык батенька, вещь это называется - СТП (Стандарт Предприятия). Или по новомодному - Регламент, Моделирование Бизнес Процессов.

ARIS в руки, старика Шеера в зубы, ну и про поясниловку не забывать.

---

При том, что нужно не забывать - даже программисты не диаграммят тотально все и вся - только концептуальные модели.

Иначе получите стандартные - "макулатура как макулатура, ничего, подписывайте".

bebop
Всё требования начинаем писать с нуля. Только в системе 150


И организация проектной библиотеки.. Бардак - штука сильно объективная, но и методы больбы с ней - довольно просты, от выбора методологии, методы, софта - зависят лишь косвенно.

Собственно говоря "Разруха... она в головах" (с)
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34092719
Фотография grexhide
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
bebop
* ARIS?
Сам я не специалист, но то что я видел разочаровало. Попытка писать в нём (не мной :) а специалистами) детальные требования к системе приводили к жутким макаронным диаграммам, где ничего не понятно.


Да вранье это все. Довольно адекватный и удобный инструмент, а скрипты его - вообще отдельная песня.

Готовить просто не умеете, вот и все.

А жуткие макаронные..... даже не смешно. Выработайте пару тройку удачных примеров и тиражируйте лучшие практики.

Опять же, от дурной головы без проблесков сознания и познания - никакой инструмент не спасет по определению.
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34093031
мод
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Проблема действительно серьезная. Лично я пришел к таким выводам:
1. Для конечного пользователя - демо реальной системы с кратким описанием не очевидных моментов ("Руководство пользователя").
2. Для разработчика - исходники с коментариями того, что также не очевидно.
Т.е. лучшее описание системы - это она сама.
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34093107
bebop
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
модПроблема действительно серьезная. Лично я пришел к таким выводам:
1. Для конечного пользователя - демо реальной системы с кратким описанием не очевидных моментов ("Руководство пользователя").
2. Для разработчика - исходники с коментариями того, что также не очевидно.
Т.е. лучшее описание системы - это она сама.
У нас есть ещё один класс заинтересованных лиц - аналитики.
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34093235
andbary
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
bebopУ нас есть ещё один класс заинтересованных лиц - аналитики. Я поступаю следующим образом: Использую Sybase PowerDesigner и рисую все основные процессы (бизнес процессы) в этом средстве с комментариями в каких местах этот процесс применяется и формулы используемые для расчетов.

ARIS мне лично не нравится, но можно успешно рисовать и в нем (именно лично!).

Подчеркну! Гарантировать истинность нарисованных схем, не сможет никто... А в этом самая серьезная проблема (макароны они из за неправильности...).
PS Сейчас во всю обсуждается данная проблема (верификация схем) в ERP, топик "Управление".
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34093280
Alexey Kudinov
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
bebopКак вы думаете цель повторного использования ранее собранных требований реалистична? Сразу оговорюсь, что не очень понял вопрос.

Если у вас есть ранее собранные требования и есть их реализация, то, разумеется, можно их сопоставить и получить некий результат, описывающий ... ну скажем степень соответствия изначально желаемого и полученого. Вопрос о применимости такого результата оставим за скобками.

Тем не менее, я бы начал описание отталкиваясь от того, что есть сейчас, а не от того как это изначально задумывалось. Хотя конечно анализ существующего положения вещей с исторической точки зрения может открыть много нового :)
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34093343
Фотография Petro123
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
bebop модПроблема действительно серьезная. Лично я пришел к таким выводам:
1. Для конечного пользователя - демо реальной системы с кратким описанием не очевидных моментов ("Руководство пользователя").
2. Для разработчика - исходники с коментариями того, что также не очевидно.
Т.е. лучшее описание системы - это она сама.
У нас есть ещё один класс заинтересованных лиц - аналитики.
странно:
У Вас у аналитикиков есть какие-нибудь программные средства для:
- понимания их работы руководством (наглядность графиков/схем и т.д.)
- постановки задачь программистам и разговора с ними на одном языке (UML например)
- документирования прошлой работы и проектов (если уволят Аналитика).
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34093383
Может кому-нить мой опыт поможет...
Я как раз сейчас занимаюсь описание одной навороченной ситемы. Система из себя представляет конструктор объектов бизнес-логики, некий middleware. Цель описания - составить документ "РУКОВОДСТВО РАЗРАБОТЧИКА" чтобы вновь пришедший в компанию разработчик смог приступить к проектированию прикладной системы использую данный конструктор.
Документ разрабатывается следующим образом... Были взяты ГОСТы 19-той серии... 503, 504, 505, 105, 402 и на основании них был составлен шаблон и документ "Руководство разработчика"...
(если интересно, могу выложить текст разделов )
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34093414
Фотография Petro123
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
ПробегалМимо.(если интересно, могу выложить текст разделов )
должностные инструкции :)
http://www.networkdoc.ru/doc/instr.html
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34093421
KGP
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
ПробегалМимо.(если интересно, могу выложить текст разделов )

если можно, то вышлите на email
тоже буду начинать, но с целью документирования для разных групп (директората, проектировцика, разработчика) - должны быть разные по теме, стилю документы
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34093460
to KGP:
выслал документ
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34093696
мод
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
bebopУ нас есть ещё один класс заинтересованных лиц - аналитики.
Я отношу их к разработчикам. Т.е. им исходники в зубы и вперед - анализируйте.
...
Рейтинг: 0 / 0
Документирование существующей ИС
    #34093764
Фотография Petro123
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
мод bebopУ нас есть ещё один класс заинтересованных лиц - аналитики.
Я отношу их к разработчикам. Т.е. им исходники в зубы и вперед - анализируйте.
как ни странно, но аналитики могут не знать ЯП
http://www.sql.ru/forum/actualthread.aspx?tid=339499

авторКрупной российской IT компании, занимающейся созданием программного обеспечения различного целевого назначения, требуется Ведущий системный аналитик/Бизнес-аналитик.

Требования:
Обязательно:
- Опыт разработки корпоративных информационных систем
- Высшее образование


Как дополнительный плюс опыт работа с:
- Visual Source Safe
- MS Project
- Visio
- ERWin
- Aris
- Sybase PowerDesigner
- IBM Rational Rose
- IBM Rational ClearQuest
- JIRA

Обязанности: - Общение с представителями Заказчика;
- Формализация требований;
- Разработка проектной документации (технико-коммерческое предложение, техническое задание, протоколы совещаний и т.п.);
- Разработка заданий для разработчиков, контроль исполнения заданий;
- Проектирование баз данных
...
Рейтинг: 0 / 0
25 сообщений из 140, страница 1 из 6
Форумы / Разработка информационных систем [игнор отключен] [закрыт для гостей] / Документирование существующей ИС
Целевая тема:
Создать новую тему:
Автор:
Закрыть
Цитировать
Найденые пользователи ...
Разблокировать пользователей ...
Читали форум (0):
Пользователи онлайн (0):
x
x
Закрыть


Просмотр
0 / 0
Close
Debug Console [Select Text]