Регламент ведения документации по проектам ОИТ

Материал из wiki.sibvaleo.com

Перейти к: навигация, поиск

В порядке ввода документирования проектов требуется:

  1. Удостовериться, что во всех таблицах Ваших проектов есть комментарии к ним самим и к каждому полю (будет проверяться sql запросом!)
  2. Удостовериться, что к каждому именованному блоку кода (процедура, функция, пакету в pl/sql, класс, метод в объектных языках) есть комментарий непосредственно в коде.
  3. Для каждого проекта в Вашем ведении создать страницу проекта на wiki
  4. Страница должна включать в себя:
    1. Название проекта
    2. Состояние проекта (в разработке, в поддержке)
    3. Разработчиков проекта
    4. Заказчиков (отдел, ведущие проект сотрудники) и пользователи проекта
    5. Общее описание, в объеме 2-3х абзацев
    6. Расположение исходного кода, включая:
    7. Для таблиц в oracle - база, схема, префикс таблиц, полный список таблиц
    8. Для пакетов pl/sql - база, схема, префикс пакетов, названия пакетов
    9. Для процедур и функций pl/sql вне пакетов - база, схема, префикс процедур, названия процедур
    10. Для базы на firebird - расположение базы (название компьютера, путь к базе)
    11. Для проекта на delphi - расположение проекта (название компьютера, путь к базе)
    12. Для страниц на портале - префикс имени либо путь к php файлам. Если файлы расположены и именованы бессистемно, то хотя бы название пакетов с курсорами для поиска страниц
    13. Для страниц на сайте - префикс имени либо путь к php файлам. Если файлы расположены и именованы бессистемно, то хотя бы название пакетов с курсорами для поиска страниц
    14. Описание связей между сущностями (таблицами) в том случае, если нет fk (внешнего ключа)
    15. Описание неочевидных особенностей в структуре данных
    16. Страница проекта должна находиться в категории Документация ОИТ
    17. Со страницы категории проектов ОИТ должны существовать ссылка на страницу проекта.
    18. Страница должна быть помечена как доступная только для IT - галочка "Статья только для IT" в уровнях доступа.


При желании обсудить этот регламент письменно, можно писать в обсуждении этой страницы.

Содержание

Назначение регламента

Термины и определения

Команда

Команда - это действие, которое запускает процедуру

Операция

Операция - это элемент бизнес процесса, в котором происходит преобразование входов и выходов (первое приближение)

Процедура

Процедура - это операция по изменению данных

Субъективная операция

Субъективная операция - операция совершаемая пользователем и содержит следующие признаки: 1. Фиксируется на произвольном носителе и в произвольной форме 2. Не связанна документами с другими процессами 3. Данные из субъективной операции передается в другие процесса на основании решения пользователя (субъекта)

Сокращения

Графические Символы

Порядок описание процесса

Сценарий
Конетекстная Диаграмма Процесса
  • Заказчик: Оформление требований к процессу
  • Аналитик: Сбор бизнес требований
  • Тестировщик: Создание приемочного теста
  • Системный аналитик: Функциональные требование к системе
  • Разработчик: Внедрение изменений
  • Тестировщик: Отладка внедрений
  • Заказчик: Исполнение приемочного теста
  • Аналитик: Регистрация изменений в технической документации

Регистрация задания

Основная статья задание пользователя

Сценарий 01:

  • Заказчик: Форма: "Приёмочный тест"
    • Заказчик: Заполнение
  • Бизнес Аналитик: Сбор бизнес требование
  • Тестировщик: Проверка формы теста
  • Бизнес Аналитик: Формирование Задания

Сбор бизнес требований

Бизнес требование выражаются в двух нотациях: Сценарий и Контекстная диаграмма процесса Подробнее в статье Контекстная диаграмма процесса

Создание приемочного теста

Вход: тест от пользователя Содержит:

  • Сценарий последовательных действий в системе пользователя
  • Требование к графическому интерфейсу пользователя
Приемочный тест - это то, что пользователь видит "своими глазами" при использование ПО

Описание функциональных требований

Функциональные требования - это сценарий, который описывает действия пользователя и отклик система на действия пользователя на основании процедур системы.

Внедрение и прием изменений

Внесение изменений в техническую текущую документацию

Формы документов Регламента

Просмотры
Личные инструменты