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