|
Документирование разработок, поддержание актуальности
|
|||
---|---|---|---|
#18+
DPH3, я из Твери, бывает заезжаю в Москву по работе и так. Из вышеизложенного и в соответствии со спецификой нашей работы у меня складывается некоторое представление по тому как нужно документирование вести. 1.Комментарии в коде ввести в регламент разработки и строго контролировать это. Это заголовки модулей, где писать назначение, описание входных параметров, что делается и что получаем в результате, ну и походу большие блоки кода комментировать. 2.Подробная схема БД, с описанием назначения таблиц, их наименования на русском,наименование полей на русском. 3.Естественно ведение версионности 4.Какие-то глабальные основополагающие алгоритмы вести в wiki, там же вести описание костылей(насчет них как-то не приходило в голову, что хорошобы их тоже описывать) 5.Всю остальную документацию касающуюся пользовательского интерфейса возложить на аналитиков, и изменять после накомпления изменений до определенного количества. ... |
|||
:
Нравится:
Не нравится:
|
|||
07.02.2012, 07:05 |
|
Документирование разработок, поддержание актуальности
|
|||
---|---|---|---|
#18+
PG81, Сугубо ИМХО: Документация по программе БЕЗУСЛОВНО нужна. Но важно правильно ответить на вопрос "Для каких целей нужна документация?". Для сдачи гос.заказчику - наверняка ГОСТ, для сдачи коммерческому заказчику - можно подобрать и согласовать что-нибудь удобное для себя и для заказчика. Но если речь идет исключительно о документировании фишек системы, то я бы не заморачивался ни на какие стандарты. Под словом "документация" в данном контексте я понимаю документацию именно для разработчиков. На мой взгляд, если в БД комментировать каждый столбец таблицы, каждую таблицу, каждую хранимую процедуру, функцию, класс и т.д. (и обязательно контролировать наличие комментария при приемке работы). То отпадет необходимость хранить толстую пачку бумажек с описанием всего и вся. Из того что действительно необходимо: - стандарты кодирования (под каждую имеющуюся платформу разработки); - стандарты проектирования БД; - стандарты GUI; - описание архитектуры системы (верхнеуровнево); Чтобы со временем не похоронить идею той или иной системы я бы еще обратил внимание на необходимость некоего документа "Концепция системы" в котором было бы описано что в этом конкретном приложении должно быть, а что делается совсем в другом модуле(это для случаев когда у вас 150 систем на предприятии). Все эти документы пишутся(или гдето тырятся) один раз, иногда корректируются, по мере необходимости. В первые месяцы работы нового сотрудника данные документы должны стать для него настольными книгами. Соответственно должен осуществляться контроль понимания и контроль следования данным документам. Однако, все это "описалово" будет просто кучей бумажек, если в один прекрасный момент "аксакал разработки" (или группа аксакалов разработки) попадет под трамвай (уволится, переедет в другой город и т.д.). Т.е необходимо грамотно управлять кадровыми рисками в разработке. Начиная от распределения задач и заканчивая правильным подбором персонала(например сложно ожидать от студента что он будет работать вечно - скорее всего научится, оборзеет (в хорошем смысле слова) и свалит). Студенты это хорошо, но необходимо обеспечить преемственность кода, идей и знаний. Это в совокупности с умеренным осмысленным документированием облегчит жизнь Вам и вашим сотрудникам. В общем... куча интересных вопросов. Дерзайте и удачи! ... |
|||
:
Нравится:
Не нравится:
|
|||
07.02.2012, 16:51 |
|
Документирование разработок, поддержание актуальности
|
|||
---|---|---|---|
#18+
PG81Из вышеизложенного и в соответствии со спецификой нашей работы у меня складывается некоторое представление по тому как нужно документирование вести. Ага, все логично. Еще, из опыта: 1) В вики имеет смысл записывать всякие организационные мелочи - что и на каких серверах живет, когда день рождения у сотрудников и как оформлять отпуска и командировки. 2) Кроме таблиц и основных алгоритмов стоит иногда описывать и отдельные решения. Типа, задача такая-то решается такими-то таблицами примерно так. Подробности не нужны, просто поверхностное описание. 3) Иногда очень полезно описывать не только "что", но и "почему". Особенно в тех случаях, когда решению предшествовало долгое обсуждение или негативный опыт. ... |
|||
:
Нравится:
Не нравится:
|
|||
07.02.2012, 22:29 |
|
Документирование разработок, поддержание актуальности
|
|||
---|---|---|---|
#18+
И еще любопытно как организована сама разработка. Т.е. использование самих программистов. Проектов несколько. Начальство стремиться уйти от того что про систему знают только один, два разработчика, чтобы исключить риск потери его знаний не важно по каким причинам. Чтобы не сотанавливалась разработка больших задач и выполнялись они в срок, и осуществлялась поддержка пользователей и выполнение мелких задач устранение глюков и багов. Как обрабатываются заявки? Чето а то как-то все сумбурно проходит никак не можем определиться с организацией работы. Было интересно послушать про опыт других.Если это конечно не секрет. ... |
|||
:
Нравится:
Не нравится:
|
|||
11.03.2012, 17:06 |
|
Документирование разработок, поддержание актуальности
|
|||
---|---|---|---|
#18+
PG81И еще любопытно как организована сама разработка. Т.е. использование самих программистов. Проектов несколько. Начальство стремиться уйти от того что про систему знают только один, два разработчика, чтобы исключить риск потери его знаний не важно по каким причинам. Чтобы не останавливалась разработка больших задач и выполнялись они в срок, и осуществлялась поддержка пользователей и выполнение мелких задач устранение глюков и багов. Как обрабатываются заявки? Чето а то как-то все сумбурно проходит никак не можем определиться с организацией работы. Было интересно послушать про опыт других.Если это конечно не секрет. По разному. Ну, например, фиксированный процент от общей занятости - на баги и мелкие заказы. Или норма "новых фишек" в месяц, вне зависимости от размера, при распланированных релизах больших фич. Можно придумать и другие принципы, главное - понять, а что важно для бизнеса :) ... |
|||
:
Нравится:
Не нравится:
|
|||
22.03.2012, 03:39 |
|
|
start [/forum/moderation_log.php?user_name=cmd03]: |
0ms |
get settings: |
6ms |
get forum list: |
10ms |
get settings: |
8ms |
get forum list: |
10ms |
check forum access: |
3ms |
check topic access: |
3ms |
track hit: |
39ms |
get topic data: |
7ms |
get forum data: |
2ms |
get page messages: |
46ms |
get tp. blocked users: |
2ms |
others: | 443ms |
total: | 579ms |
0 / 0 |