Рабочий пример ведёт читателя к первому результату раньше справочника
Зачем
Зачем это нужно
Карта расхождений не позволяет старому README победить актуальный код молча
Реальные команды делают фрагменты документации проверяемыми в сборке
Вопросы
Частые вопросы
Как проверить сгенерированные примеры?
Запускайте их в чистом окружении и, по возможности, включайте в CI как doctest или отдельный проект. Проверьте версии зависимостей и нужные переменные. Кодовый блок, который выглядит правдоподобно, может содержать устаревший метод или пропущенный импорт.
Нужно ли документировать внутренние функции?
Только если это помогает поддержке сложного механизма, а не пользователю API. Публичная документация должна быть стабильной и не обещать внутренние детали. Для команды используйте комментарии к причинам решений и архитектурные записи; очевидный код не стоит пересказывать построчно.
Как поддерживать документацию актуальной?
Назначьте владельца, связывайте изменение API с обязательной правкой текста и запускайте примеры автоматически. Генерируемую справку можно строить из типов, но сценарии и ограничения требуют редакции. При ревью проверяйте не только наличие строки, а совпадение поведения и версии.
Рядом
Соседние страницы каталога
Дальше — весь каталог задач: поиск по названию, темы и фильтры.