powered by simpleCommunicator - 2.0.53     © 2025 Programmizd 02
Форумы / Microsoft SQL Server [игнор отключен] [закрыт для гостей] / описание\документация
10 сообщений из 10, страница 1 из 1
описание\документация
    #38746867
denis_viktorovich
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Доброго времени суток!
Поделитесь плиз опытом, как вы храните\поддерживаете описание больших критичных процедур(наборов процедур обеспечивающих определенный функционал)? Про комментарии в коде конечно понятно, что они нужны.
Но хотелось бы, чтобы посмотреть алгоритм мог не только разработчик. например человек, который будет писать ТЗ, на доработку, или анализировать некую ситуацию...
...
Рейтинг: 0 / 0
описание\документация
    #38746885
Гавриленко Сергей Алексеевич
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Очень просто.

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

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

И да, при чем тут MSSQL?
...
Рейтинг: 0 / 0
описание\документация
    #38747226
Фотография alexeyvg
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
denis_viktorovichПоделитесь плиз опытом, как вы храните\поддерживаете описание больших критичных процедур(наборов процедур обеспечивающих определенный функционал)?В той же системе хранения сорсов, где хрянится и сам код этих процедур.
...
Рейтинг: 0 / 0
описание\документация
    #38747422
denis_viktorovich
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Гавриленко Сергей АлексеевичИ да, при чем тут MSSQL?

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

З.Ы. Временами возникает необходимость описать, что делает некий набор хранимок, вот и думаю, как проще и лучше.
...
Рейтинг: 0 / 0
описание\документация
    #38747423
denis_viktorovichпочти вся логика в хранимках и триггерах MS SQL
Если у вас бизнес-логика в триггерах, то думаю, что и документация не поможет разобраться.
...
Рейтинг: 0 / 0
описание\документация
    #38747457
Glory
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
denis_viktorovichВременами возникает необходимость описать, что делает некий набор хранимок,
А как этот набор хранимок создали без описания того, что они должны делать ?
...
Рейтинг: 0 / 0
Период между сообщениями больше года.
описание\документация
    #39922368
denis_viktorovich
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Доброго времени суток!
Поскольку снова актуально, хочу апнуть тему и немного прояснить ситуацию.
Пресловутый набор хранимок берет данные из нескольких баз (MES, плановая, констр-ская), на выходе имеет некую структуру (перегоночную таблицу) для перекачки данных в другую систему, заполнение происходит при помощи кучи case-ов, скалярок, в зависимости от импортированных, расчетных параметров и т.д. Писалось все изначально без оформленного ТЗ и довольно долго дорабатывалось разными разработчиками, в т.ч. и мной на основании ТЗ, писем, служебных и т.д. Хочется получить некое описание, которое станет отправной точкой для последующих более четких Т.З., рефакторинга, а также тыкания пальцем пользователя в алгоритм, для объяснения ему почему в одном случае работает так, а в другом иначе. Делал попытку разбить итоговый набор данных по полям и описывать из какого источника в каком случае берется, фильтры, преобразования и т.д. Довольно громоздко получается.
З.Ы. Как лучше всего решать подобные задачи? Что в итоге - потоки данных, объемное текстовое описание, блок схема?
...
Рейтинг: 0 / 0
описание\документация
    #39922377
Владислав Колосов
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
denis_viktorovich,

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

Должна быть система управления заданиями - TFS, Redmine, Gira и тому подобное. Для разработки в VS удобно использовать TFS, можно непосредственно связывать коммиты в системе версионирования с конкретной задачей. Программные объекты должны иметь заголовки - автор, когда, зачем. В таком направлении двигаться.
...
Рейтинг: 0 / 0
описание\документация
    #39922384
Фотография Focha
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
denis_viktorovich
Доброго времени суток!
Поскольку снова актуально, хочу апнуть тему и немного прояснить ситуацию.
Пресловутый набор хранимок берет данные из нескольких баз (MES, плановая, констр-ская), на выходе имеет некую структуру (перегоночную таблицу) для перекачки данных в другую систему, заполнение происходит при помощи кучи case-ов, скалярок, в зависимости от импортированных, расчетных параметров и т.д. Писалось все изначально без оформленного ТЗ и довольно долго дорабатывалось разными разработчиками, в т.ч. и мной на основании ТЗ, писем, служебных и т.д. Хочется получить некое описание, которое станет отправной точкой для последующих более четких Т.З., рефакторинга, а также тыкания пальцем пользователя в алгоритм, для объяснения ему почему в одном случае работает так, а в другом иначе. Делал попытку разбить итоговый набор данных по полям и описывать из какого источника в каком случае берется, фильтры, преобразования и т.д. Довольно громоздко получается.
З.Ы. Как лучше всего решать подобные задачи? Что в итоге - потоки данных, объемное текстовое описание, блок схема?



я делал документацию больше для других разработчиков, ну и для себя.
Название хранимки - краткий текст, что она делает и этот текст вставлял перед хранимкой на сервере
Подробно расписывал уже в документации и так каждую таблицу, хранимку, функцию.
Иногда документация может быть на >100 страниц, но если там все четка описано, тогда она поможет всем, если там одна вода, то толку нет.
...
Рейтинг: 0 / 0
описание\документация
    #39922385
Фотография Focha
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Владислав Колосов
denis_viktorovich,
Для аналитика - UML диаграммы


Тоже использовал, очень удобный инструмент, что бы увидеть всю связь и логику.
...
Рейтинг: 0 / 0
10 сообщений из 10, страница 1 из 1
Форумы / Microsoft SQL Server [игнор отключен] [закрыт для гостей] / описание\документация
Целевая тема:
Создать новую тему:
Автор:
Закрыть
Цитировать
Найденые пользователи ...
Разблокировать пользователей ...
Читали форум (0):
Пользователи онлайн (0):
x
x
Закрыть


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