Рекоме ндации по графическим пояснениям
Эта страница переведена сообществом на русский язык, но нуждается в улучшениях. Если вы хотите принять участие в переводе свяжитесь с @alexgton.
Эта страница устарела и скоро будет удалена. См. Как внести вклад.
Поддержание согласованности в документации имеет решающее значение, и для достижения этого был разработан специальный стандарт визуализации процессов в смарт-контрактах.
Графические пояснения
График обработки сообщений
Для изображения обработки сообщений рекомендуется использовать графическое представление, напоминающее график смарт-контракта, с метками для транзакций и сообщений.
Если порядок транзакций не имеет значения, вы можете опустить их метки. Это упрощает диаграмму, облегчая чтение и понимание деталей, связанных с сообщениями и контрактами.
Примитивы аннотаций
- Избегайте использования большого количества разных и ярких цветов.
- Используйте модификацию рисунков, например, использование пунктирной линии границы.
- Для лучшего понимания различные транзакции могут отображаться с различными стилями линий (сплошными и пунктирными).
Пример обработки сообщения
Изучите примеры непосредственно в Visio message-processing.vsdx.
Форматы и Цвета
Шрифты
- Семейство шрифтов Inter для всего текста в диаграммах.
Цвета — светлый режим
- Рисунок карандашом (тема по умолчанию)
Цвета — темный режим
- Шрифт
#e3e3e3 - Фон
#232328 - Светлое выделение (стрелки и границы схемы)
#058dd2 - Темное выделение (стрелки и границы схемы)
#0088cc - Внутренний фон (для вложенных блоков)
#333337
Политика контроля версий
- Установите диаграммы в документации в формате SVG для схем, чтобы обеспечить читаемость на различных устройствах.
- Храните исходные файлы в репозитории Git проекта в каталоге
/static/visio, что упростит их изменение в будущем.
Диаграмма последовательности
В случае сложных и повторяющихся схем связи между 2-3 участниками рекомендуется использовать диаграмму последовательности. Для сообщений используйте нотацию обычного синхронного сообщения.
Пример
