Документация, которая нужна в IT-проекте | Андрей Путин
Вставка
- Опубліковано 31 тра 2024
- 5 видов технической документации, которые мы используем на своих проектах IT-разработки.
В ролике мы используем аббривиатуры:
WMS система (Warehouse Management System), система управления информацией по складу
PIM система (Product Information Management), система управления информацией о товарах
OMS система (Order Management System), система управления информацией о заказах.
API - Application Programming Interface, описание способов взаимодействия одной компьютерной программы с другими
GitOps - метод имплементации непрерывной поставки (Continuous Delivery)
Спикер: Андрей Путин, управляющий партнер KT.Team
0:00 Документация, которую нужно писать в IT-разработке
0:45 Сервисная карта
3:31 Схема бизнес-процессов
6:25 Пользовательская документация для техподдержки
7:55 Документация эндпоинтов
9:22 GitOps
Полезные ссылки:
Видео "Не пишите документацию": • Не пишите документацию...
Видео "Сервисная шина и система - кто должен инициировать сообщения?": • Сервисная шина и систе...
Видео "Как делать интеграции правильно": • Как делать интеграции ...
Наш сайт: kt-team.ru/
Наш блог: t.me/kt_team_blog
#esb #ipaas #integration_by_parts #integration #enterprise_service_bus #anypoint_platform
#шина #сервисная_шина #ETL
очень круто, надо будет про гит опс почитать и поюзать.
Проблема всей документации, что на неё всегда тратится очень много времени - на написание, на актуализацию (особенно в ахтунг разработке) + из за ошибок а ней, может прилететь по голове. И работа с документацией очень часто лоу приоритет. А если сделал хорошо, то мало кто заметит и оценит.
Помню писал админ мануал и юзер мануал (поддерживал в норм состоянии). Приучил коллег читать и просто ссылки кидал с ответами на их вопросы - экономия была колоссальная.
Все были рады - но пока я этот делал руководство с пеноё у рта бегало и ругалось, что так долго, почему доки разнык..... куча всего было. Когда попросили сделать тоже для другого проекта - озвучил план и сроки, ответ был - ну сделай по быстрому и пофигу на косяки.... я мягко говоря был удивлен, так как там вскрылись архитектурнык проблемы, разрывы в БП и много чего еще, а решать и фиксить никто ничего не хотел)))))
Понимаю! Очень близкие проблемы. Поэтому и записали наше видео.
Архитектурные проблемы мы решаем SOA схемами и декомпозицией алгоритмов bpmn схемами (не всех, только ключевых и интеграций), сейчас много усилий для выравнивания компетенций в этом прилагаем.
Спасибо за коммент!
@@utandr вам спасибо за контент!! Очень хорош.
Добрый день!
Очень понравилась идея с сервизной картой. Нахожу ее очень полезной для аналитиков (BA/SA) для ознакомления с проектом.
Однако, кажется решает ту же функцию схем BPMN. В интернетах не могу найти информацию по сервисной карте. Возможно вы можете подсказать где можно более подробно ознакомится?
насчет фамилии уже были шутки?)))
Но я , на всякий случай, лайкнул и подписался)