Структурируем документацию проекта. Часть 3
5. Бэк документация
В этом разделе описываем, как работает система. Как обрабатываются запросы пользователей, как осуществляется взаимодействие внутренних компонентов и внешних систем и т.д.
5.1. Описание метода API
Описывать методы API можно несколькими способами - с помощью Swagger или вручную, но главное, чтобы методы были описаны. Это позволит минимизировать ошибки при разработке с последующим поддержанием работоспособности системы. О постановке на разработку API можно почитать тут.
Пример запроса:
https://{baseurl}/parent/56568989
Пример тела ответа:
5.2. Описание топика Kafka
Если есть интеграции с помощью Kafka, то необходимо задокументировать структуру сообщений. Вот как это можно сделать.
Примеры сообщений:
5.3. Технические алгоритмы/функции
В этом разделе содержатся сценарии и алгоритмы работы системы, сценарии взаимодействия внутренних и внешних компонентов. К основным алгоритмам приводите альтернативные сценарии работы системы. Чтобы наглядно отобразить работу системы используйте диаграммы последовательности. Для удобства и поддержания единой картины настраивайте связи между алгоритмами, описаниями методов и сообщений.
Диаграмма последовательности для технического алгоритма
6. Продуктовая аналитика
Раздел, содержащий события и метрики для последующего анализа взаимодействия пользователей с цифровым продуктом.
6.1. События
Описание опорных точек, классифицирующих пользователя.
6.2. Метрики
Карта метрик, чтобы понимать, что и как можно посчитать. Метрики для удобства можно вести по категориям: технические, продуктовые.
6.3. Логирование
Описание запланированных к сохранению логов для последующего разборов инцидентов.
Если вы хотите получить шаблон в pdf формате, то переходите по ссылке в телеграмм-канал.
В этом кейсе я расскажу, как я из идеи об инструменте которого мне не хватало в моих рабочих процессах, с чистого листа создал в одиночку стартап, проведя его через все этапы от проектирования до запуска, своими руками (и мозгами) делая всю работу. Какой получился результат, принёс проект пользу лично мне, и оказался ли полезен людям. Погнали!
Если вы, как и я, планируете на бумаге — делюсь удачными шаблонами, нашла вот здесь
Сегодня хочу поделиться очень необычным кейсом по созданию сайта для салона цветов и кофе. Здесь можно наслаждаться ароматом свежих букетов и параллельно побаловать себя вкуснейшим напитком.
«Мы буквально задыхались в этой рутине. Не было понимания, как разделить задачи, как взять людей, чему их учить. Всё держалось на нас, и это было неуправляемо»
Юзабилити (usability) — это совокупность характеристик продукта (в нашем случае веб-сайта), определяющих его удобство и эффективность для пользователей. Высокая юзабилити означает, что пользователи:
Прекрасные цифры в отчетах, куча лидов, цена по рынку. Но клиент не доволен качеством заявок, сделок нет. Все заявки мимо: "не дозвоны", "не оставляли". Специалист разводит руками, грешит на отдел продаж. — Что делать? — Давайте разбираться!
Периодически я смотрю подборки с сайтами по типу Made on Tilda. Как делают красивые, но обычно неэффективные сайты.
Личный кабинет (или «аккаунт пользователя») в интернет-магазине — это не просто страница со сведениями о заказах и профиле. Сегодня он становится полноценным центром взаимодействия, где клиент может решить все основные задачи: от отслеживания статуса заказов до получения специализированных рекомендаций и формирования отчётности. В статье рассмотрим…
Привет!
Хочу поделиться инструментом для визуализации данных Мосбиржи, Nasdaq, NYSE и AMEX. Графики можно посмотреть на странице finmap.org. Сейчас я занимаюсь этим проектом один, а планов много, например, добавить данные торгов стран Европы, Азии и Латинской Америки. Исходный код опубликован на GitHub. Очень надеюсь, здесь найдутся те, кто готов пр…