Добро пожаловать в форум, Guest  >>   Войти | Регистрация | Поиск | Правила | В избранное | Подписаться
Все форумы / Microsoft SQL Server Новый топик    Ответить
 описание\документация  [new]
denis_viktorovich
Member

Откуда: Екб
Сообщений: 1206
Доброго времени суток!
Поделитесь плиз опытом, как вы храните\поддерживаете описание больших критичных процедур(наборов процедур обеспечивающих определенный функционал)? Про комментарии в коде конечно понятно, что они нужны.
Но хотелось бы, чтобы посмотреть алгоритм мог не только разработчик. например человек, который будет писать ТЗ, на доработку, или анализировать некую ситуацию...
15 сен 14, 14:49    [16576594]     Ответить | Цитировать Сообщить модератору
 Re: описание\документация  [new]
Гавриленко Сергей Алексеевич
Member

Откуда: Moscow
Сообщений: 37069
Очень просто.

Сначала пишется документация. По ней пишется код. По той же документации тестеры пишут автотесты. Если надо что-то менять, то все меняется в той же последовательности - документы, код, тесты.

Документация хрантися в той же системе контроля версий, что и код.

И да, при чем тут MSSQL?
15 сен 14, 15:02    [16576685]     Ответить | Цитировать Сообщить модератору
 Re: описание\документация  [new]
alexeyvg
Member

Откуда: Moscow
Сообщений: 31444
denis_viktorovich
Поделитесь плиз опытом, как вы храните\поддерживаете описание больших критичных процедур(наборов процедур обеспечивающих определенный функционал)?
В той же системе хранения сорсов, где хрянится и сам код этих процедур.
15 сен 14, 20:40    [16578269]     Ответить | Цитировать Сообщить модератору
 Re: описание\документация  [new]
denis_viktorovich
Member

Откуда: Екб
Сообщений: 1206
Гавриленко Сергей Алексеевич
И да, при чем тут MSSQL?


Спасибо за ответ. Да, вопрос наверное более общий. Просто в данном случае почти вся логика в хранимках и триггерах MS SQL, поэтому тут и спросил.

З.Ы. Временами возникает необходимость описать, что делает некий набор хранимок, вот и думаю, как проще и лучше.
16 сен 14, 08:25    [16579002]     Ответить | Цитировать Сообщить модератору
 Re: описание\документация  [new]
случайно заглянул
Guest
denis_viktorovich
почти вся логика в хранимках и триггерах MS SQL

Если у вас бизнес-логика в триггерах, то думаю, что и документация не поможет разобраться.
16 сен 14, 08:29    [16579008]     Ответить | Цитировать Сообщить модератору
 Re: описание\документация  [new]
Glory
Member

Откуда:
Сообщений: 104760
denis_viktorovich
Временами возникает необходимость описать, что делает некий набор хранимок,

А как этот набор хранимок создали без описания того, что они должны делать ?
16 сен 14, 09:26    [16579165]     Ответить | Цитировать Сообщить модератору
Между сообщениями интервал более 1 года.
 Re: описание\документация  [new]
denis_viktorovich
Member

Откуда: Екб
Сообщений: 1206
Доброго времени суток!
Поскольку снова актуально, хочу апнуть тему и немного прояснить ситуацию.
Пресловутый набор хранимок берет данные из нескольких баз (MES, плановая, констр-ская), на выходе имеет некую структуру (перегоночную таблицу) для перекачки данных в другую систему, заполнение происходит при помощи кучи case-ов, скалярок, в зависимости от импортированных, расчетных параметров и т.д. Писалось все изначально без оформленного ТЗ и довольно долго дорабатывалось разными разработчиками, в т.ч. и мной на основании ТЗ, писем, служебных и т.д. Хочется получить некое описание, которое станет отправной точкой для последующих более четких Т.З., рефакторинга, а также тыкания пальцем пользователя в алгоритм, для объяснения ему почему в одном случае работает так, а в другом иначе. Делал попытку разбить итоговый набор данных по полям и описывать из какого источника в каком случае берется, фильтры, преобразования и т.д. Довольно громоздко получается.
З.Ы. Как лучше всего решать подобные задачи? Что в итоге - потоки данных, объемное текстовое описание, блок схема?
4 фев 20, 16:14    [22072853]     Ответить | Цитировать Сообщить модератору
 Re: описание\документация  [new]
Владислав Колосов
Member

Откуда:
Сообщений: 7868
denis_viktorovich,

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

Должна быть система управления заданиями - TFS, Redmine, Gira и тому подобное. Для разработки в VS удобно использовать TFS, можно непосредственно связывать коммиты в системе версионирования с конкретной задачей. Программные объекты должны иметь заголовки - автор, когда, зачем. В таком направлении двигаться.
4 фев 20, 16:30    [22072873]     Ответить | Цитировать Сообщить модератору
 Re: описание\документация  [new]
Focha
Member

Откуда: Москва
Сообщений: 521
denis_viktorovich
Доброго времени суток!
Поскольку снова актуально, хочу апнуть тему и немного прояснить ситуацию.
Пресловутый набор хранимок берет данные из нескольких баз (MES, плановая, констр-ская), на выходе имеет некую структуру (перегоночную таблицу) для перекачки данных в другую систему, заполнение происходит при помощи кучи case-ов, скалярок, в зависимости от импортированных, расчетных параметров и т.д. Писалось все изначально без оформленного ТЗ и довольно долго дорабатывалось разными разработчиками, в т.ч. и мной на основании ТЗ, писем, служебных и т.д. Хочется получить некое описание, которое станет отправной точкой для последующих более четких Т.З., рефакторинга, а также тыкания пальцем пользователя в алгоритм, для объяснения ему почему в одном случае работает так, а в другом иначе. Делал попытку разбить итоговый набор данных по полям и описывать из какого источника в каком случае берется, фильтры, преобразования и т.д. Довольно громоздко получается.
З.Ы. Как лучше всего решать подобные задачи? Что в итоге - потоки данных, объемное текстовое описание, блок схема?



я делал документацию больше для других разработчиков, ну и для себя.
Название хранимки - краткий текст, что она делает и этот текст вставлял перед хранимкой на сервере
Подробно расписывал уже в документации и так каждую таблицу, хранимку, функцию.
Иногда документация может быть на >100 страниц, но если там все четка описано, тогда она поможет всем, если там одна вода, то толку нет.
4 фев 20, 16:40    [22072888]     Ответить | Цитировать Сообщить модератору
 Re: описание\документация  [new]
Focha
Member

Откуда: Москва
Сообщений: 521
Владислав Колосов
denis_viktorovich,
Для аналитика - UML диаграммы


Тоже использовал, очень удобный инструмент, что бы увидеть всю связь и логику.
4 фев 20, 16:41    [22072889]     Ответить | Цитировать Сообщить модератору
Все форумы / Microsoft SQL Server Ответить