Эффективное погружение новичка в проект
Когда вы решаете создать свой собственный продукт, вам понадобится ряд инструментов, которые помогут новичкам быстро погрузиться в идею вашего продукта и его техническую реализацию. Эти инструменты должны помочь новичкам понять:
Как реализована архитектура вашего продукта?
Как пользоваться UI-кой вашего продукта?
Какие бизнес-процессы реализуются в вашем продукте?
Как запустить все компоненты продукта локально и начать с ним взаимодействовать через API?
Как бизнес-процессы используют архитектурные компоненты вашего продукта?
Как проверить, что новичок спустя определенное время работы понимает, как работает продукт?
Как через эту архитектуру протекают бизнес-процессы вашего продукта?
Вот несколько инструментов, которые могут вам помочь:
Icepanel.io позволяет реализовать визуальное представление архитектуры вашего продукта по нотации C4. Все элементы, такие как внешние системы, сервер, фронтенд клиент, мобильное приложение и бизнес-процессы, в которых они задействованы, могут быть удобно и понятно отражены в виде схемы, где каждый элемент имеет функционал вложенности, то есть вы можете провалиться в него для получения более детализированного контекста.
Proto.io позволяет спроектировать ваш пользовательский интерфейс в понятной форме. Вы можете спроектировать мобильное приложение или сайт.
Stormbpmn позволяет спроектировать BPMN-схемы ваших бизнес-процессов совместно с другими участниками команды.
Readme.so - это удобный readme editor. Он содержит большое количество текстовых заготовок, с помощью которых вы сможете быстро сформировать качественный readme-файл. В нем можно разместить руководство по локальному поднятию экосистемы ваших микросервисов, запуск локального окружения, настройку сертификатов и т.д.
Для того чтобы представить новичку связь между архитектурными компонентами (определенными на C4 борде ) и bpmn схемами можно использовать knowlege based инструмент .
В инструменте должен иметься механизм классификатора с помощью которого можно будет отметить связанные бизнес-процессы и компоненты.
Далее в поиске можно будет с помощью фильтров найти все необходимые ресурсы.Скрин представлен из интерфейса инстурмента управления знаниями teamly.
teamly - российский аналог confluence. Инструмент изначально позиционируется как база знаний + тестирование сотрудников на предмет понимания продукта в разработке которого они принимают участие.Очень удобный интерфейс создания набора тестов для аттестации сотрудника .