README.md

Название модуля

• краткое описание
• какую проблему решает
• как эту проблему решает

Архитектура и зависимости

• от чего зависит модуль
• из каких частей состоит
• как эти части взаимодействуют
• как протекают данные

Установка

• установка зависимостей (если требуется)
• установка модуля

Примеры использования

• общий пример того как использовать модуль
• пример как передавать параметры/взаимодействовать с модулем

Конфигурация и взаимодействие

• какие параметры принимает модуль, на что они влияют, значения по умолчанию (можно приложить типы)
• какие события отправляет/слушает модуль
• как с модулем взаимодействовать

Известные проблемы

• техдолг
• возможные проблемы при тестировании/деплое

Идеи для улучшения

• то что не успели реализовать или пока не требуется
• видение идеальной реализации (которая сейчас невозможна из-за каких-то ограничений)

Материалы

• ссылка на библиотеки используемые в модуле
• статьи на которые опирались во время разработки

Журнал изменений

• опишите если знаете/помните прошлые изменения в модуле
• добавляйте описание новых фич/багов по мере их поступления