(c) Larry Ewing, Simon Budig, Garrett LeSage
с 1994 г.

Кафедра Информатики и Математического Обеспечения

ПетрГУ | ИМиИТ | О кафедре | Проекты | Лаборатория ИТС | Семинары НФИ/AMICT
Сотрудники | Учебный процесс | Табель-календарь | Курсовые и выпускные работы
Вычислительные ресурсы | Публикации | Архив новостей | Контактная информация

Шаблоны документов

Основной документ проекта составляется на основе структуры документации. Также представляются следующие документы:
  • Индивидуальные отчеты разработчиков
  • Отчет о текущем состоянии проекта
  • Протокол собраний участников проекта
  • Человеческие ресурсы проекта
  • План тестирования
  • Журнал тестирования

    Индивидуальные отчеты разработчиков

    Формат отчета (wh-Developer.txt):
    ...
    <дата> <вид деятельности> <затраченное время> <описание>
    ...
    Где:
    <дата> - DD.MM.YYYY.
    <вид деятельности> - аббревиатура. Предлагаемый список аббревиатур (wh-abbrev.txt):
    ME - Встречи
    LC - Другие виды общения кроме встреч
    PP - Составление плана проекта
    PR - Проектирование, написание документа проектирования
    DO - Документирование кода или написание документации для пользователя
    CO - Кодирование (включая отладку)
    TE - Тестирование
    AD - Административные поручения
    TM - Техническая поддержка
    RE - Разработка требований, написание спецификации требований
    RD - Чтение документации для нужд проекта
    <затраченное время> - объем затраченного времени в данный день на данный вид деятельности с точностью до 0.5 часа (30 минут).
    <описание> включает краткое описание решаемой задачи, состояние ее решения, оценка требуемых ресурсов для окончательного ее решения.

    Пример (wh-Ivanov.txt):
     3.03.2005      ME      0.5     Первая встреча с заказчиком
     9.03.2005      ME      0.5     Собрание с менеджером
    11.03.2005      ME      1       Обсуждение плана проекта
    12.03.2005      PP      2       Написание плана проекта
    13.03.2005      PP      1       Корректировка плана проекта
    14.03.2005      LC      0.5     Собрание с менеджером - обсуждение замечаний

    Отчет о текущем состоянии проекта

    Скрипт для расчета суммарного объема часов.

    Данный скрипт обрабатывает индивидуальные отчеты разработчиков с маской названия файлов - "*.txt" в текстовом формате (progress-YYYY-MM-DD.txt):

    <Разработчик>
    <индивидуальный отчет>
    Где:
    <Разработчик> - Обозначение автора индивидуального отчета (например, его фамилия и имя).
    <Индивидуальный отчет> - индивидуальный отчет разработчика. Индивидуальный отчет может содержать пустые строки и комментарии в виде строк, начинающихся с символа "#".

    Для получения списка параметров достаточно запустить скрипт с опцией справки

    perl report.pl -h
    Пример отчета, созданного с помощью скрипта (progress-2004-03-01.txt):
    ./report.pl -r progress -o progress-2004-03-01.txt -s 16.02.2004 \
    -e 01.03.2004 -g Group1
    ОТЧЕТ О ТЕКУЩЕМ СОСТОЯНИИ ПРОЕКТА
    
    Группа:			Group1
    Период:			16.02.2004 - 01.03.2004
    
    
    Участник		в этот период	Всего часов
    ---------------------------------------------
    Андрей Ложкин           13		210
    Иван Иванов             17		298
    Петр Петров             16		258
    Сергей Сидоров          17		167
    Василий Чашкин          22		278
    
    
    Текущее состояние проекта
    -----------------------------
    
    
    Завершенные документы (название и ссылка)
    --------------------------------------
    
    
    Отклонения/комментарии менеджмента
    ---------------------------------
    

    Протокол собраний участников проекта

    Формат протокола (meeting-YYYY-MM-DD.txt):
    Дата: <дата собрания>
    
    Присутствуют:
    <участники1>
    Отсутствуют: 
    <участники2>
    
    1. Начало
    <руководитель> начал собрание в <время начала>
    
    2. План собрания
    <план собрания>
    
    3. Ход собрания
    <ход собрания>
    
    4. Результаты собрания
    <результаты собрания>
    
    5. Окончание
    <руководитель> окончил собрание в <время завершения>
    Где:
    <дата собрания> - дата собрания в формате DD.MM.YYYY
    <участники1>, <участники2> - список присутствующих и отсутствующих участников собрания соответственно. Руководитель собрания и секретарь помечаются соответствующими обозначениями.
    <руководитель> - руководитель собрания
    <время начала> - время начала собрания в формате HH:MM
    <план собрания> - план собрания в виде списка обсуждаемых пунктов. Составляется в начале каждого собрания руководителем.
    <ход собрания> - краткая информация о ходе собрания, предложениях участников и т.п.
    <результаты собрания> - распределение задач м/у разработчиками, отметка о изменении в состоянии проекта (завершение и/или начало стадий проекта и т.п.), другие ключевые моменты.
    <время завершения> - время завершения собрания в формате HH:MM

    Пример протокола (meeting-2004-04-08.txt):
    Дата: 08.04.2004
    
    Присутствуют:
       Андрей Ложкин, руководитель
       Василий Чашкин, секретарь
       Иван Иванов
       Петр Петров
       Сергей Сидоров
       Виктор Поварежкин, инструктор
    
    Отсутствуют:
       Никто не отсутствует
    
    1. Начало
       А.Ложкин начал собрание в 15:15.
    
    2. План собрания
       2.А. - Обсуждение текущего состояния стадии проектирования
          
    3. Ход собрания
    
       3.A - Документ проектирования
    
        И.Иванов предложил добавить структуру link в структуры данных
        для хранения MTU.
        Продолжение вычистки документа проектирования. Дополнительные
        лог-файлы должны быть представлены в документе проектирования. 
        Типы данных должны быть унифицированы.
    
       3.B - Документ плана тестирования
          
         Добавлены секции введения и тестирования.
    
    4. Результаты собрания
    
       - П.Петров: завершение документа проектирования - модуль events
         calculator и архитектура системы.
    
       - А.Ложкин: завершение документа проектирования - модуль message
         mapping, работа над планом тестирования.
    
       - И.Иванов: реализация - работа над планом тестирования,
         подготовка к использованию стандартов программирования GNU
    
       - В.Чашкин: завершение документа проектирования - модуль log reader.
    
       - С.Сидоров: реализация - структуры данных в заголовочных файлах.
    
    5. Окончание
       А.Ложкин  окончил собрание в 15:40.

    Человеческие ресурсы проекта

    Отчет о затраченных человеческих ресурсах можно получить с помощью предлагаемого скрипта. По умолчанию приняты предлагаемые обозначения видов деятельности. При необходимости их можно изменить в исходном коде скрипта.

    Формат отчета (hr-PROJECT.txt):

    ОТЧЕТ О ЧЕЛОВЕЧЕСКИХ РЕСУРСАХ
    
    Группа:			<Проект>
    
    
    Участник		<Аббревиатуры>	Другое	Итого
    -------------------------------------------------------
    <Разработчик>          	<Время>		<Время>	<Время>
    -------------------------------------------------------
    Итого                  	<Время>		<Время>	<Время>
    
    
    Описание обозначений
    -----------------------
    <Описание>
    Где:
    <Проект> - название проекта/группы.
    <Аббревиатуры> - аббревиатуры видов деятельности.
    <Разработчик> - Обозначение участника проекта (например, его фамилия и имя).
    <Время> - соответствующие значения затраченного времени.
    <Описание> - расшифровка используемых аббревиатур.

    Пример отчета (hr-Group1.txt):

    ОТЧЕТ О ЧЕЛОВЕЧЕСКИХ РЕСУРСАХ
    
    Группа:			Group1
    
    
    Участник		RE	PR	CO	TE	ME	DO	Другое	Итого
    -------------------------------------------------------------------------------------
    Андрей Ложкин          	0	3	25	20	54	3	105	210
    Иван Иванов            	1	0	4	74	58	4	157	298
    Петр Петров            	9	0	42	37	66	3	101	258
    Сергей Сидоров         	12	0	45	32	28	0	50	167
    Василий Чашкин         	0	0	50	29	53	0	146	278
    -------------------------------------------------------------------------------------
    Итого                  	22	3	166	192	259	10	559	1211
    
    
    Описание обозначений
    -----------------------
    RE - Разработка требований, написание спецификации требований
    PR - Проектирование, написание документа проектирования
    CO - Кодирование (включая отладку)
    TE - Тестирование
    DO - Документирование кода или написание документации для пользователя
    ME - Встречи
    

    План тестирования

    Шаблон плана тестирования (test-plan-templ.txt):
    Тест: <номер>
    Тип теста: <тип>
    Описание: <описание>
    Входные данные: <вход>
    Ожидаемый результат: <выход>
    Где:
    <номер> - номер (идентификатор) теста.
    <тип> - тип теста: простой, общий, краевой, негативный, специальный, блочный, интеграционный, валидационный.
    <описание> - краткое описание теста.
    <вход> - входные данные в виде набора конкретных значений, ограничений или условий на данные.
    <выход> - ожидаемый результат.
    Пример плана тестирования (test-plan.txt):
    Тест: 21
    Тип теста: Блочный, общий
    Описание: Проверка ф-ии суммирования элементов массива
    Входные данные: массив элементов A[i]
    Ожидаемый результат: сумма элементов массива A[1]+A[2]+...+A[n]
    
    Тест: 32
    Тип теста: Блочный, негативный
    Описание: Проверка ф-ии суммирования элементов несуществующего массива
    Входные данные: несуществующий массив
    Ожидаемый результат: 0
    
    Тест: 56
    Тип теста: Интеграционный, общий
    Описание: Сохранение данных формы в файл
    Входные данные: заполненая в соответствии с требованиями форма
    Ожидаемый результат: файл с данными
    
    Тест: 62
    Тип теста: Интеграционный, краевой
    Описание: Чтение и вывод на экран файла нулевой длины
    Входные данные: файл нулевой длины
    Ожидаемый результат: пустое окно
    
    Тест: 127
    Тип теста: Валидационный, общий
    Описание: Расчет математического ожидания выборки
    Входные данные: файл с элементами выборки
    Ожидаемый результат: математическое ожидание
    
    

    Журнал тестирования

    Шаблон журнала тестирования (test-exec-templ.txt):
    +--------+--------+-----------+---------------+--------+---------+-------------+
    |  Дата  |  тест  |  попытка  |  тестировщик  |  вход  |  выход  |  результат  |
    +--------+--------+-----------+---------------+--------+---------+-------------+
    | <дата> | <тест> | <попытка> | <тестировщик> | <вход> | <выход> | <результат> |
    Где:
    <дата> - дата проведения тестирования.
    <тест> - описание теста и/или идентификатор теста из плана тестирования.
    <попытка> - номер попытки или кол-во проведенных тестов.
    <тестеровщик> - Обозначение участника проекта (например, его фамилия и имя).
    <вход> - входные данные.
    <выход> - ожидаемый результат.
    <результат> - Результат прохождения теста (положительный или отрицательный), описание найденных ошибок или несоответствий с ожидаемым результатом.
    Пример журнала тестирования (test-exec.txt):
    +----------+---------+-----------+---------------+--------------------+--------------+--------------------+
    |   Дата   |  тест   |  попытка  |  тестировщик  |        вход        |     выход    |      результат     |
    +----------+---------+-----------+---------------+--------------------+--------------+--------------------+
    | 01.01.01 | тест 21 |     3     |  Иванов И.И.  | Произв массив A[i] | сумма эл-тов | Негативный         |
    |          |         |           |               |                    |              | неправильная сумма |
    |          |         |           |               |                    |              | при кол-ве = 0     |
    +----------+---------+-----------+---------------+--------------------+--------------+--------------------+
    | 02.01.01 | тест 21 |     2     |  Иванов И.И.  | массив A[i] с      |       0      | Положительный      |
    |          |         |           |               | кол-вом = 0        |              |                    |
    +----------+---------+-----------+---------------+--------------------+--------------+--------------------+
    | 02.01.01 | тест 21 |     7     |  Иванов И.И.  | Произв массив A[i] | сумма эл-тов | Положительный      |
    +----------+---------+-----------+---------------+--------------------+--------------+--------------------+
    |          |         |           |               |                    |              |                    |
    

    Отчет по проекту

    Отчет по проекту оформляется с использованием макета.