Кто пишет документацию

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

Ответ

Документацию обычно пишут технические писатели, разработчики или сами члены команды проекта.

Кто участвует:

  • Разработчики — пишут API-документацию, комментарии в коде (например, Swagger, JSDoc).
  • Техписатели — создают user guides, FAQ, инструкции для конечных пользователей.
  • QA-инженеры — описывают тест-кейсы, баг-репорты.
  • Продакт-менеджеры — формируют требования (PRD, user stories).

Пример API-документации (Swagger/OpenAPI):

openapi: 3.0.0
info:
  title: User API
  version: 1.0.0
paths:
  /users:
    get:
      summary: Get all users
      responses:
        '200':
          description: A list of users

Лучшие практики:

  • Документировать по мере разработки (не откладывать).
  • Использовать единый стиль и инструменты (Confluence, Notion, Markdown).
  • Вовлекать всю команду в ревью документации.