Какой набор документации принят как стандарт на нынешней работе

«Какой набор документации принят как стандарт на нынешней работе» — вопрос из категории Контроль качества и отчётность, который задают на 23% собеседований Менеджер Проектов. Ниже — развёрнутый ответ с разбором ключевых моментов.

Ответ

В моей практике мы используем гибридный подход, сочетая Agile-документацию с ключевыми традиционными артефактами:

  1. User Stories/Epics (Jira/Confluence) - основной формат требований
  2. API документация (Swagger/OpenAPI) для интеграций
  3. ADR (Architecture Decision Records) - для значимых технических решений
  4. Wiki-страницы (Confluence) с:
    • Онбордингом
    • Глоссарием терминов
    • Схемами интеграций
  5. Runbook (операционные инструкции)
  6. Чеклисты релизов

Пример минимального ADR:

# 2024-01-15 Миграция на PostgreSQL

## Контекст
Устаревшая СУБД вызывает проблемы с производительностью...

## Решение
Выбрана PostgreSQL 15 с кластерной конфигурацией...

## Последствия
+ Поддержка JSONB
- Требуется обучение команды