|
описание\документация
|
|||
---|---|---|---|
#18+
Доброго времени суток! Поделитесь плиз опытом, как вы храните\поддерживаете описание больших критичных процедур(наборов процедур обеспечивающих определенный функционал)? Про комментарии в коде конечно понятно, что они нужны. Но хотелось бы, чтобы посмотреть алгоритм мог не только разработчик. например человек, который будет писать ТЗ, на доработку, или анализировать некую ситуацию... ... |
|||
:
Нравится:
Не нравится:
|
|||
15.09.2014, 14:49 |
|
описание\документация
|
|||
---|---|---|---|
#18+
Очень просто. Сначала пишется документация. По ней пишется код. По той же документации тестеры пишут автотесты. Если надо что-то менять, то все меняется в той же последовательности - документы, код, тесты. Документация хрантися в той же системе контроля версий, что и код. И да, при чем тут MSSQL? ... |
|||
:
Нравится:
Не нравится:
|
|||
15.09.2014, 15:02 |
|
описание\документация
|
|||
---|---|---|---|
#18+
denis_viktorovichПоделитесь плиз опытом, как вы храните\поддерживаете описание больших критичных процедур(наборов процедур обеспечивающих определенный функционал)?В той же системе хранения сорсов, где хрянится и сам код этих процедур. ... |
|||
:
Нравится:
Не нравится:
|
|||
15.09.2014, 20:40 |
|
описание\документация
|
|||
---|---|---|---|
#18+
Гавриленко Сергей АлексеевичИ да, при чем тут MSSQL? Спасибо за ответ. Да, вопрос наверное более общий. Просто в данном случае почти вся логика в хранимках и триггерах MS SQL, поэтому тут и спросил. З.Ы. Временами возникает необходимость описать, что делает некий набор хранимок, вот и думаю, как проще и лучше. ... |
|||
:
Нравится:
Не нравится:
|
|||
16.09.2014, 08:25 |
|
описание\документация
|
|||
---|---|---|---|
#18+
denis_viktorovichпочти вся логика в хранимках и триггерах MS SQL Если у вас бизнес-логика в триггерах, то думаю, что и документация не поможет разобраться. ... |
|||
:
Нравится:
Не нравится:
|
|||
16.09.2014, 08:29 |
|
описание\документация
|
|||
---|---|---|---|
#18+
denis_viktorovichВременами возникает необходимость описать, что делает некий набор хранимок, А как этот набор хранимок создали без описания того, что они должны делать ? ... |
|||
:
Нравится:
Не нравится:
|
|||
16.09.2014, 09:26 |
|
описание\документация
|
|||
---|---|---|---|
#18+
Доброго времени суток! Поскольку снова актуально, хочу апнуть тему и немного прояснить ситуацию. Пресловутый набор хранимок берет данные из нескольких баз (MES, плановая, констр-ская), на выходе имеет некую структуру (перегоночную таблицу) для перекачки данных в другую систему, заполнение происходит при помощи кучи case-ов, скалярок, в зависимости от импортированных, расчетных параметров и т.д. Писалось все изначально без оформленного ТЗ и довольно долго дорабатывалось разными разработчиками, в т.ч. и мной на основании ТЗ, писем, служебных и т.д. Хочется получить некое описание, которое станет отправной точкой для последующих более четких Т.З., рефакторинга, а также тыкания пальцем пользователя в алгоритм, для объяснения ему почему в одном случае работает так, а в другом иначе. Делал попытку разбить итоговый набор данных по полям и описывать из какого источника в каком случае берется, фильтры, преобразования и т.д. Довольно громоздко получается. З.Ы. Как лучше всего решать подобные задачи? Что в итоге - потоки данных, объемное текстовое описание, блок схема? ... |
|||
:
Нравится:
Не нравится:
|
|||
04.02.2020, 16:14 |
|
описание\документация
|
|||
---|---|---|---|
#18+
denis_viktorovich, Документирование может быть многоуровневым. Для разработчиков - комментарии в процедурах, подписание расширенных свойств таблиц и полей, обязательное рецензирование с целью соблюдения формальным правил и понимания комментариев. Для аналитика - UML диаграммы, ТЗ и другие материалы, содержащие постановку задачи от заказчика и решение. Для архитектора - текстовые описание принципов интеграции, UML диаграммы. Должна быть система управления заданиями - TFS, Redmine, Gira и тому подобное. Для разработки в VS удобно использовать TFS, можно непосредственно связывать коммиты в системе версионирования с конкретной задачей. Программные объекты должны иметь заголовки - автор, когда, зачем. В таком направлении двигаться. ... |
|||
:
Нравится:
Не нравится:
|
|||
04.02.2020, 16:30 |
|
описание\документация
|
|||
---|---|---|---|
#18+
denis_viktorovich Доброго времени суток! Поскольку снова актуально, хочу апнуть тему и немного прояснить ситуацию. Пресловутый набор хранимок берет данные из нескольких баз (MES, плановая, констр-ская), на выходе имеет некую структуру (перегоночную таблицу) для перекачки данных в другую систему, заполнение происходит при помощи кучи case-ов, скалярок, в зависимости от импортированных, расчетных параметров и т.д. Писалось все изначально без оформленного ТЗ и довольно долго дорабатывалось разными разработчиками, в т.ч. и мной на основании ТЗ, писем, служебных и т.д. Хочется получить некое описание, которое станет отправной точкой для последующих более четких Т.З., рефакторинга, а также тыкания пальцем пользователя в алгоритм, для объяснения ему почему в одном случае работает так, а в другом иначе. Делал попытку разбить итоговый набор данных по полям и описывать из какого источника в каком случае берется, фильтры, преобразования и т.д. Довольно громоздко получается. З.Ы. Как лучше всего решать подобные задачи? Что в итоге - потоки данных, объемное текстовое описание, блок схема? я делал документацию больше для других разработчиков, ну и для себя. Название хранимки - краткий текст, что она делает и этот текст вставлял перед хранимкой на сервере Подробно расписывал уже в документации и так каждую таблицу, хранимку, функцию. Иногда документация может быть на >100 страниц, но если там все четка описано, тогда она поможет всем, если там одна вода, то толку нет. ... |
|||
:
Нравится:
Не нравится:
|
|||
04.02.2020, 16:40 |
|
|
start [/forum/topic.php?fid=46&fpage=71&tid=1686554]: |
0ms |
get settings: |
10ms |
get forum list: |
14ms |
check forum access: |
4ms |
check topic access: |
4ms |
track hit: |
29ms |
get topic data: |
12ms |
get forum data: |
3ms |
get page messages: |
48ms |
get tp. blocked users: |
2ms |
others: | 13ms |
total: | 139ms |
0 / 0 |