Size: a a a

Архитектура ИТ-решений

2019 August 21

IP

Igor Petetskikh in Архитектура ИТ-решений
Andrey Kharintsev
Необходимо решение, чтобы документировать изменения структуры (модели) базы данных. Обычно от аналитика приходит огромный документ Word с таблицей внутри, когда его спрашиваешь что изменилось в документе, описывающем БД - он говорит не знаю, вот моя постановка читай ищи. Расскажите свой опыт.
как минимум тот же ворд поддерживает механизм правок и рецензий
источник

RT

Roman Tsirulnikov in Архитектура ИТ-решений
Andrey Kharintsev
Необходимо решение, чтобы документировать изменения структуры (модели) базы данных. Обычно от аналитика приходит огромный документ Word с таблицей внутри, когда его спрашиваешь что изменилось в документе, описывающем БД - он говорит не знаю, вот моя постановка читай ищи. Расскажите свой опыт.
вести SQL DDL модель в Git, изменения принимать в виде пулл-реквестов
источник

A

Andrey Kharintsev in Архитектура ИТ-решений
А если из нет  правок и рецензий, он просто сделал copy-paste из другого документа.
источник

EI

Eugene Istomin in Архитектура ИТ-решений
Andrey Kharintsev
А если из нет  правок и рецензий, он просто сделал copy-paste из другого документа.
Тогда это не "структура (модель) базы данных" - а просто записи в абстрактной таблице.
источник

DK

Daria Kaftan in Архитектура ИТ-решений
Andrey Kharintsev
Необходимо решение, чтобы документировать изменения структуры (модели) базы данных. Обычно от аналитика приходит огромный документ Word с таблицей внутри, когда его спрашиваешь что изменилось в документе, описывающем БД - он говорит не знаю, вот моя постановка читай ищи. Расскажите свой опыт.
а с какими целями это нужно?
источник

DK

Daria Kaftan in Архитектура ИТ-решений
у нас сейчас изменения бд записываются в скрипт и проливаются с помощью liquidbase
источник

IP

Igor Petetskikh in Архитектура ИТ-решений
извините, но мне кажется, что в большой компании, подобная работа с вордовскими документами - в режиме рецензии и правок - признак уважения к коллегам, чтоли... именно потому что открывая документ сразу видно КТО и ЧТО правил....

таким образом, это не вопрос технического решения, а вопрос культуры.
источник

DK

Daria Kaftan in Архитектура ИТ-решений
соответтсвенно, сам скрипт в системе контроля версий
источник

IP

Igor Petetskikh in Архитектура ИТ-решений
я верно понял, что аналитик присылает вам описание структуры таблицы, в условно произвольной форме, в вордовском документе?
источник

DK

Daria Kaftan in Архитектура ИТ-решений
Сами документы можно засунуть в систему контроля версий. Но тут надо обучить с этим работать аналитика. и заставлять описывать коммиты правильно, чтобы уакзывать, где были изменения и какие.
источник

VA

Viktor Alexandrov in Архитектура ИТ-решений
Andrey Kharintsev
Необходимо решение, чтобы документировать изменения структуры (модели) базы данных. Обычно от аналитика приходит огромный документ Word с таблицей внутри, когда его спрашиваешь что изменилось в документе, описывающем БД - он говорит не знаю, вот моя постановка читай ищи. Расскажите свой опыт.
DDL + патчи к нему, если БД SQL-ная, иначе - скрипты создания "чего там есть в вашей БД", всё остальное от лукавого, ИМХО
источник

VA

Viktor Alexandrov in Архитектура ИТ-решений
Есть ещё варианты с ER-моделью типа в plantuml, но я не пробовал насколько это удобно
источник

RT

Roman Tsirulnikov in Архитектура ИТ-решений
Igor Petetskikh
извините, но мне кажется, что в большой компании, подобная работа с вордовскими документами - в режиме рецензии и правок - признак уважения к коллегам, чтоли... именно потому что открывая документ сразу видно КТО и ЧТО правил....

таким образом, это не вопрос технического решения, а вопрос культуры.
этот подход порождает две проблемы:
- описание БД не описывает прикладную сущность
- нужно транслировать из Word в SQL

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

Если аналитик хоть что-то понимает в БД = он знает SQL DDL
источник

IP

Igor Petetskikh in Архитектура ИТ-решений
Roman Tsirulnikov
этот подход порождает две проблемы:
- описание БД не описывает прикладную сущность
- нужно транслировать из Word в SQL

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

Если аналитик хоть что-то понимает в БД = он знает SQL DDL
само собой.
источник

IP

Igor Petetskikh in Архитектура ИТ-решений
просто если уже у человека проблема в том, что аналитик даже базовым функционалом общераспространенного инструмента не может воспользоваться, то ставить спец инструменты - не поможет.
источник

RT

Roman Tsirulnikov in Архитектура ИТ-решений
Кстати, а зачем нужно расшаривать модель БД между командами? У вас интеграция через БД?
источник

DK

Daria Kaftan in Архитектура ИТ-решений
Viktor Alexandrov
DDL + патчи к нему, если БД SQL-ная, иначе - скрипты создания "чего там есть в вашей БД", всё остальное от лукавого, ИМХО
То есть прямо сразу от аналитика скрипт получить? Я так поняла, у них в ворде большая постановка со разными реверансами. Предлагаете заменить таблицу бд на скрипт?
источник

RT

Roman Tsirulnikov in Архитектура ИТ-решений
Автор вопроса просил решение для документирования структуры БД, а не всей поставовки по проекту)
источник

RT

Roman Tsirulnikov in Архитектура ИТ-решений
Самое простое - вести документы в Confluence или аналоге, там встроенная история правок с diff есть.
Хорошо работает, если изменения последовательны.
источник

RT

Roman Tsirulnikov in Архитектура ИТ-решений
Если изменения идут параллельно во множестве веток и могут применяться к действующей спецификации в произвольном порядке, то пожалуй, ничего лучще Git не найти.
Выбрать текстовый формат ведения документации, например Asciidoctor, reST, Markdown, etc, на свой вкус
источник