Бывает, объясняешь что-то, и вдруг спотыкаешься: «тут не расскажешь, это надо показывать». Если это случилось с вами при написании доки или статьи, значит, пришло время нарисовать схему.
Можно сделать набросок в любом удобном графическом редакторе или даже на бумаге. Разместите изображение в подпапке images/ в папке материала и добавьте в статью при помощи Markdown-синтаксиса. Со временем мы отрисуем вашу схему в дизайне Доки и обновим её.
Или творческий путь: если вы умеете работать с Figma, то можете создать схему в стиле Доки самостоятельно.
Это публичная Figma со схемами Доки. Она открыта для комментирования. Вы можете просматривать и копировать стили элементов, а также скопировать себе всё целиком для дальнейшей работы.
Две самые важные вещи размещены на странице «Guide»:
- Пошаговая инструкция по созданию схемы с нуля.
- Компоненты схем — мельчайшие кирпичики, из которых можно собрать свою схему. Их можно копировать, также они доступны в меню Assets.
На странице «Примеры» находятся уже собранные схемы. В них можно подсмотреть, как представить ту или иную информацию.
Не бойтесь, что нарисуете схему «как-то не так». Мы поможем в процессе ревью.
Созданную в Figma схему экспортируйте в формате PNG в масштабе 2x:
Для схем, созданных в иных редакторах, придерживайтесь следующих требований:
- формат PNG,
- ширина изображения не менее 1200px,
- текст достаточно крупный, чтобы прочитать его, не приближая картинку,
- тёмная цветовая тема, щадящая зрение при ночной работе.