Стандарты проекта nest-ldap
1. Состав команды, распределение ролей и ответественности
Разработчики :
- Нуйкин Александр: менеджер, секретарь, ответственный за
распределение задач, график выполнения работ а также Web-страничку
проекта и автоматизацию процесса публикации
отчетов.
- Димитров Вячеслав: менеджер по метрикам проекта.
- Артемьев Дмитрий: менеджер по архитектуре.
2. Используемые в проекте формы отчетности и взаимодействия
Формы взаимодействия:
- Встречи внутри группы (1-2 раза в неделю)
- Встречи с инструкторами (1 раз в неделю)
- Встречи с заказчиком
- Переписка по электронной почте
- Общение через Instant Messegers
- Использование системы автоматизации приема и публикации отчетов
- Индивидуальные отчеты разработчиков (еженедельно)
- Протоколы собраний
График собраний:
Стандартно:
- Пятница - 13.00 (ауд. 217) : встреча с инструкторами,
заказчиками; собрание разработчиков.
Дополнительно:
- Среда - 11.30 (возле акт. зала) : собрание разработчиков.
Правила создания индивидуальных отчетов (для разработчиков):
- Каждый разработчик в течении недели, пишет свой индивидуальный
отчет в каталог /home/nuikin/nest_ldap/journal/wh/current/
- Имена отчетов должны соответствовать шаблону wh_developer.txt,
где developer - логин разработчика на kappa.cs.karelia.ru.
- Еженедельно в ночь со среды на четверг, индивидуальные отчеты за
прошедшую неделю автоматически закрываются для записи. С этого
момента вновь написанные отчеты относятся к следующей недели.
- Публикуются на Веб только отчеты соответствующие шаблону
форматирования и с использованием стандартных аббревиатур
(см. стандартные аббревиатуры кафедры ИМО: http://cs.karelia.ru/~kulakov/courses/se/template.php#wh). Плюс дополнительное ограничение : имя разработчика = владелец файла-отчета.
- Для проверки разработчиком написанного им отчета он может
использовать скрипт /home/nuikin/nest_ldap/auto/check_wh.sh. Отчеты,
не прошедшие проверку, считаются не действительными, и публиковаться
на Веб не будут.
Правила создания протоколов собраний (для секретарей):
- Протоколы собраний создаются секретарем в каталоге
/home/nuikin/nest_ldap/journal/meetings/
- Имена протоколов собраний должны соответствовать шаблону
meeting_YYYY-MM-DD.txt, где YYYY - год, MM - месяц, DD - день.
- Файл протокола собрания может создать любой разработчик проекта,
но публиковаться на Веб будут лишь протоколы созданные секретарем
(-ями) и соответствующие шаблону имени.
3. Стандарты документации
- Все документы проекта должны быть набраны в кодировке koi8-r.
- Все документы проекта должны иметь расширения html или php.
- Все рисунки, вставляемые в html-код, должны иметь расширение png и
иметь размеры не более 200 Кб.
- Имена всех файлов изображений - uml диаграмм должны начинаться с
"uml_" , т.е. соответствовать шаблону "uml_*.png".
- Использовать Javadoc для документирования исходного кода.
4. Стандарты кодирования
- При кодировании следует придерживаться официального соглашения о
стиле кодирования на Java - Java Code Conventions
- Комментарии желательно писать на английском языке (но можно и на
русском при возникновении проблем с английским языком)