По мере того, как я набираюсь опыта в написании программного обеспечения, я постоянно нахожусь в поиске инструментов, которые упрощают мою жизнь, а также экономят много времени. Некоторые из инструментов, которые я использую:

  1. Vim Everywhere — начиная с моих редакторов кода, заканчивая командной строкой терминала и моим браузером — у всех есть сочетания клавиш vim. Черт, я даже настроил свою клавиатуру, чтобы создать настройку HYPERKEY и режим Vim Everywhere с помощью Hammerspoon и Karabiner.
  2. Sourcegraph — Поиск кода во всех репозиториях. Использование расширения Sourcegraph в VSCode очень удобно.
  3. Alfred — это приложение дает вам возможности поиска, похожие на Mac Spotlight, но на стероидах. Я создаю настраиваемые веб-поиски в этом приложении, чтобы переходить на веб-сайты с параметризованными URL-адресами за считанные секунды. Alfred Powerpack может сделать вас продуктивнее, чем когда-либо, благодаря персонализированным рабочим процессам и бесконечной автоматизации основных задач!

Но PlantUML — один из самых впечатляющих инструментов!

Что, если бы я сказал вам, что вы можете кодировать свою архитектуру, взаимодействие, последовательность и диаграммы классов? PlantUML делает именно это!

Я создал шаблоны для различных типов инженерных диаграмм, которые я могу быстро открыть и начать рисовать свой проект!

Например, это мой шаблон диаграммы архитектуры/взаимодействия.

Просто вставьте указанный выше код на онлайн-сервер. Это должно сгенерировать что-то вроде этого —

Теперь, чтобы добавить взаимодействие между компонентами на эту диаграмму, вам просто нужно добавить —

service -> q : Push Elements into queue

Вот и все — вы можете кодировать, сохранять, контролировать версии, копировать/вставлять свои схемы с невероятной скоростью! У вас также есть много вариантов для значков, которые вы используете на этих диаграммах.

Вы хотите построить диаграмму последовательности? Это мой шаблон -

Я призываю вас изучить все различные диаграммы в plantuml.com. Это определенно сделает вашу жизнь очень легкой. Например, я смог составить схему высокоуровневого дизайна очень простого чат-приложения примерно за 10 минут →

Совет профессионала:

1. Скачайте VSCode.
2. Установите PlantUML VSCode extension.
3. Создайте файл *.puml.
4. Добавьте свой UML-код Plant и запустите PlantUML: Preview Current Diagram, чтобы сгенерировать диаграмму.

Вам не нужны draw.io, lucidchart.com, smartdraw.com и т. д. Сделайте папку git-репозиторием, и вы получите потрясающий локальный инструмент проектирования UML с контролем версий!

Из вашего следующего проекта проектная документация может фактически стать частью вашего репозитория кода. Мы можем использовать CI/CD для повторного создания этих диаграмм (или Makefile с целью создать диаграмму). Эти диаграммы можно импортировать в README и другие документы уценки. Документация может обновляться вместе с вашим кодом по мере развития вашей архитектуры.