Перейти к основному содержимому

Какая документация ведется по проекту?

  1. Если проект новый, то есть ли устав проекта?
  2. Есть ли какое-то описание системы?
    • Репозиторий с техническими заданиями
    • Глоссарий
    • Описание релизов
    • Описание основных процессов
    • Описание GUI
    • Печатные формы
    • Интеграции
    • Ссылки на исследования (АБ и прочее)
    • Описание системы нотификаций (СМС, Имеил)
    • Матрица ролей и доступов
    • Инциденты и пост-мортем
    • Документация для разработчиков
    • Документация для тестировщиков
  3. Где хранятся технические задания?
  4. Поддерживается ли их актуальность?
  5. Есть ли правила оформления задач?
  6. Где ведется документация по API? Когда и кто документирует API?
  7. Есть ли релизный чек-лист?
  8. Составляются ли тест-планы?
  9. Пишутся ли тест-кейсы?
    • Где хранятся?
    • Кто и когда актуализирует?
    • Каков процент покрытие кейсами?
  10. Есть ли публичный roadmap?
    • Кто его поддерживает и актуализирует?
    • Есть ли какие-то правила оформления?
    • Примеры: Trello, ClickHouse
  11. Пишется ли release notes?
  12. Есть ли библиотека компонентов?
  13. Есть ли витрина компонентов?
    • Storybook
    • knapsack.cloud
    • supernova.io
  14. Есть ли SLA (Service Level Agreement / Соглашение об уровне сервиса) на работу системы? Какие метрики для нас важны?
    • Доступность
    • Процент ответов типа 500х от сервиса
    • Время обслуживания запроса
    • Количество запросов в секунду + описание балансировщика нагрузки
  15. Есть ли хэлп для пользователей?
    • Кто целевая аудитория?
    • Кто его поддерживает?
    • Когда по задаче готовится хэлп?