Вы документируете свои модификации?

[mazzy]

А что с документированием? Кто-нибудь делает?

[Dzemon]

А что под этим подразумевается? Если комментарии в коде, то ДА, а если отдельная дока, то НЕТ.

[komar]

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

[mazzy]

боюсь спросить, но спросить очень хочется
как соотносится количество работ на документирование и собственно внедрение?

Если отвечать нельзя, то пойму.

[komar]

Примерно внедрение к документированию как 2 к 1. При этом поди пойми, где заканчивается внедрение, а где начинается документирование - спецификация на разработку пишется вместе с ТЗ, а заканчивается, когда разработка уже готова. Или пользовательская документация - это документирование или внедрение?

[komar]

кроме того, это сокращает работы на собственно внедрение уже на втором похожем проекте - что быстрее - писать то же самое 10 раз или один раз задокументировать и собрать человеческую версию?

[mazzy]

спасибо

[komar]

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

[mazzy]

как много людей ответило, что всегда документируют изменения.

[komar]

Quote:

Originally Posted by mazzy

как много людей ответило, что всегда документируют изменения.

И как много на практике обратного....

[George Nordic]

Мои 5 копеек:
Все модификации описаны в тех заданиях консультантами. Или должны, по идее. Или сами долны написать, для утверждения, что бы знать, что делать.
Потом я утверждаю номер проекта, например модификация такая-то - номер М0123. И пишем проек с номером М0123_GNRD_КраткоеИмяПроекта.
GNRD - Это кто писал модификацию (изначально).
Весь код в модификации подписывается номером проекта:
//М0123_GNRD_КраткоеИмяПроекта --->
...........
//М0123_GNRD_КраткоеИмяПроекта <---
Т.О. мы получаем код, понятно из какого проекта, а проект - уже изначально описан.

Немного, конечно, инфы, но в условиях ограниченного времени - пойдет. Все лучше, чем ничего.

С Уважением,
Георгий.

[Likefire]

Документирование необходимо вести в обязательном порядке. В нашей конторе, как углубление этого дела, создана специальная база данных в Лотусе, где фиксируется: а). Ход работы над проектом по дням, по исполняемым действиям, по разработчикам, и ещё по прочему разному; б). Детализация вносимых в исходный (стандартный) функционал, изменений: какой объект, какие претерпел изменения, либо был создан , либо ещё что. Кроме того, в обязательном порядке создаваемый и модифицируемый код снабжается комментариями по отработаной схеме. Ну и конечно же: ТЗ и документация по функционалу - в обязательном порядке создаётся. Но засчёт отлаженности процесса, при внимании, которое уделяется вопросу документирования, времени на это уходит немного: в районе 5-8% от общего времени затрат по проекту.

[slava_imported]

Quote:

Originally Posted by George Nordic

Мои 5 копеек:
Все модификации описаны в тех заданиях консультантами. Или должны, по идее. Или сами долны написать, для утверждения, что бы знать, что делать.
Потом я утверждаю номер проекта, например модификация такая-то - номер М0123. И пишем проек с номером М0123_GNRD_КраткоеИмяПроекта.
GNRD - Это кто писал модификацию (изначально).
Весь код в модификации подписывается номером проекта:
//М0123_GNRD_КраткоеИмяПроекта --->
...........
//М0123_GNRD_КраткоеИмяПроекта <---
Т.О. мы получаем код, понятно из какого проекта, а проект - уже изначально описан.

Немного, конечно, инфы, но в условиях ограниченного времени - пойдет. Все лучше, чем ничего.

С Уважением,
Георгий.

Вот примерно так же, и кроме того скрипт, которые вставляет комментарии в коде, параллельно добавляет ссылку на измененный/добавленный элемент в отдельную таблицу «журнал модификаций». Ну и в add-ins добавлен пункт меню, позволяющий добавлять классы/формы/таблицы в «журнал» текущего проекта.

[bobkov_imported]

Quote:

Originally Posted by mazzy

боюсь спросить, но спросить очень хочется
как соотносится количество работ на документирование и собственно внедрение?

Если отвечать нельзя, то пойму.

<{POST_SNAPBACK}>

Чего же тут секретного, ответить не трудно, только непонятно, что на самом деле ты имел в виду, количество работ или продолжительность работ или трудоемкость работ. Разные работы по написанию, согласованию, утверждению документов могут выполняться с самого начала и до конца проекта - в ходе обследования, системного проектирования, технического проектирования, реализации, опытной эксплуатации системы. Что имеется в виду? Все документы или какие-то определенные? А "собственно внедрение" это, наверное, все остальные виды работ?
Уточни пож-ста, тогда можно что-то содержательное ответить...