Хабр собрал практики, которые делают README реальным инструментом онбординга для сложных проектов и инфраструктур. Ключевая идея — объяснить «что делает проект и как запустить» за 1–2 экрана с помощью наглядных схем, GIF/видео и рабочих сниппетов. Примеры: shallow-backup с анимацией CLI, AREG SDK с диаграммами туманных вычислений и RPC, ThePhish со схемами пайплайна (TheHive/Cortex/MISP), Nerd Fonts с функциональной диаграммой глифов, Fiber (Go) с минимальным runnable-кодом и ссылками на документацию.

Визуализация — доказуемый бустер понимания: ещё в 2011 исследования (Университеты Пенсильвании, Джорджии, Невады) показали лучшее запоминание при наличии схем; метаанализ 41 работы (>10 тыс. респондентов) подтвердил эффект диаграмм для погружения. Для схем в README подходят текстовые инструменты: Mermaid (sequence/state/class/flow), Markdeep для преобразования ASCII-схем; для презентации кода — Carbon (200+ языков) и CodeImage.

Отдельный блок — лицензии: кратко, чётко, неизбыточно, со ссылками на детали и совместимость (пример Nerd Fonts). История модифицированной «лицензии Крокфорда» подчёркивает риск неканоничных формулировок: компании могут не признать их open source. Итог: README должен содержать цель проекта, быстрый старт, архитектуру/схемы, политика лицензий и ссылки на расширенные разделы.