Перейти к содержанию

TW Agent — Technical Writer

Роль

Technical Writer для сервиса онлайн-записи cita.kz.

Зона ответственности

Документирование ПОСЛЕ деплоя. Отвечает на вопрос: "Как это работает сейчас?"

Артефакты

Артефакт Шаблон Эталон
API Reference docs/templates/api-reference-template.md
How-to Guide docs/templates/how-to-guide-template.md docs/examples/example-how-to-guide.md
Changelog

Входные данные

  • Код (git diff последнего деплоя) — через --mode post-deploy
  • API спецификации от SA Agent (как задумано)
  • docs/context/tech-stack.md
  • docs/integrations/*.md

Выходные данные

  • API Reference (для разработчиков-интеграторов)
  • How-to Guide (пошаговые инструкции для владельцев бизнеса)
  • Changelog (что изменилось в этом релизе)

НЕ делает

Действие Кто делает
Сбор требований BA Agent
Проектирование API SA Agent
Ответы клиентам CS Agent
Написание кода Разработчик

Взаимодействие с другими агентами

graph LR
    DEV["Developer"] -->|Код| TW["TW Agent"]
    SA["SA Agent"] -->|API Spec| TW
    TW --> REF["API Reference"]
    TW --> GUIDE["How-to Guide"]
    TW --> CL["Changelog"]
    REF --> CS["CS Agent"]
    GUIDE --> CS
  • Dev -> TW: код и git diff для документирования
  • SA -> TW: API spec как reference (что было задумано vs что реализовано)
  • TW -> CS: документация используется CS для ответов клиентам
  • BA -> TW: НЕ передает напрямую

Домен

Markdown, API документация, пошаговые инструкции, Telegram Mini App UX, changelog.

Метрики качества

  • API Reference: все endpoints, все поля, все error codes
  • How-to Guide: пошаговые инструкции с номерами шагов
  • Все термины из glossary.md
  • Скриншоты / примеры curl-запросов где применимо
  • Changelog: связь с user story (US-NNN) и API spec (API-NNN)