TGViewer
(Не)Системная аналитика by Андрей Царев (Не)Системная аналитика by Андрей Царев @notsystemanalysis · 7.57K subscribers
Post #354 11.8K
Front_doc.pdf242.5 KB Back_doc.pdf102.6 KB
Пример документации для Фронта и Бэка

Ловите примеры спецификаций, которые можно использовать в работе. На самом деле, там никакого рокет саенс.

Для фронта: описать, как формируется страница, приложить макеты, сделать таблицу, где было бы явно понятно из какого метода какие атрибуты брать, и как с ними работать.
Для бэка: описать метод, входные параметры, алгоритм работы, какие ошибки могут возникнуть и конечно же, приложить примеры запросов.

Вообще встречал два подхода к ведению доки:
1) Когда описываются компоненты системы, страницы, методы. Изменения по задачам вносятся в эти документы. Например, добавляются новые элементы на фронт, меняется валидация или добавляются атрибуты в API. Готовая задача в джире выглядит как ворох ссылок с описанием того, что должен быть поправлено и тут и там.
2) Когда описываются компоненты системы и отдельно ведутся постановки. Постановка - страница, где конкретно указано, что в рамках этой задачи нужно поправить на фронте, бэке и тд. Плюс такого подхода - разрабы в одном месте видят все сразу. Минусы - аналитику приходится делать двойную работу, и, после выкатки задачи в прод, править раздел с описанием системы.

А как ведете документацию вы? Какие подходы и шаблоны используете?
  • ❤ 51
  • 🔥 17
  • 👍 12
  • ❤‍🔥 3
  • 🤔 3
  • 👏 2
  • 😁 1
More from @notsystemanalysis
  1. Sep 21, 2026Цикл работы агента «Напиши мне в сваггере три метода», попросил я как-то агента, который в…
  2. Sep 18, 2026Друзья, нужна ваша помощь У нашего ученика Вадима нашли рак ободочной кишки в 19 лет. Несм…
  3. Sep 18, 2026Почему тебе не нужно перегружать контекст лишней инфой Ситуация: работаешь себе с нейронко…
  4. Sep 16, 2026Обучение с куратором в октябре 5 октября стартует очередной групповой поток с куратором, в…
  5. Sep 15, 2026Покидайте курсы по ИИ для чайников (не себе, честное слово, подруга попросила)
  6. Sep 14, 2026Агент vs Чат «Я составил реально грамотный промпт, закинул его в чат и получил результат.…
Threads Profile ViewerView any public Threads profile without an account.Open ThreadLook →Writing with AI? Make it sound human.Metric37 rewrites AI drafts so they read naturally. Free AI detector, 1,500 words free.Try Metric37 →