Код-ревью Middle ТЗ, ГОСТ 34 и документирование обновлено

Ревью фрагмента ТЗ

Вопрос

Фрагмент раздела «Требования к функциям» ТЗ на систему электронного документооборота. Найди проблемы.

4.2.1 Система должна обеспечивать удобную работу с документами.
4.2.2 Система должна поддерживать согласование документов, их подписание ЭП, архивацию и т. п.
4.2.3 Документ согласуется всеми участниками маршрута в течение разумного срока.
4.2.4 Система должна выдерживать необходимую нагрузку.
4.2.5 Руководитель может удалить любой документ.
4.2.6 Подписанный ЭП документ не может быть изменён или удалён.

Коротко

Каждое требование должно быть атомарным, проверяемым и непротиворечивым. Пункт 4.2.6 хороший.

Что должен найти ревьюер

  1. Ошибкастрока 1
    «Удобную работу» не проверить: нужны конкретные функции и измеримые критерии
  2. Ошибкастрока 2
    Несколько функций в одном пункте и «и т. п.»: объём не определён
  3. Ошибкастрока 3
    «Разумный срок» неоднозначен: нужен срок в часах или днях и действие при просрочке
  4. Стильстрока 4
    Нагрузка без чисел; кроме того, это NFR в разделе функций
  5. Ошибкастрока 5
    Противоречит 4.2.6: руководитель может удалить и подписанный документ?
  6. Безопасностьстрока 5
    Удаление без аудита и без роли-исключения для архивных документов опасно

Разбор

Каждое требование должно быть атомарным, проверяемым и непротиворечивым. Пункт 4.2.6 хороший. Пункты 4.2.5 и 4.2.6 надо согласовать: например, удалять можно только неподписанные черновики, и действие журналируется.

Ответьте сами, а не прочитайте

В тренажёре вопрос попадёт в повторения и вернётся, когда начнёт забываться. Плюс билеты с зачётом: 20 вопросов, не больше 2 ошибок.

Термины по теме