Обновить документацию проекта

Составлено whenreset · Источники: OpenAI · Источники проверены: 2026-09-12

Обнови документацию этого проекта, устранив расхождения между документами и между документацией и реализацией. Выдай готовые правки, а не только список замечаний.

Начни с корневого README, оглавлений документации и существующих каталогов docs. Составь карту действующих руководств, справочных материалов, исторических записей и сгенерированного содержимого. Определи основные сценарии — запуск, настройка, развёртывание и устранение неполадок, — не прося меня выбирать файлы. Иди по связанным документам и по исходному коду, конфигурации и определениям скриптов, которые нужны для проверки. Не ограничивай задачу одним документом и не принимай исторические утверждения за текущие факты.

Проверь противоречащие друг другу команды, имена параметров конфигурации, пути и процедуры; недостающие предварительные условия; отсутствующие точки входа в руководства; битые локальные ссылки. Отдавай предпочтение фактической реализации и проверяемым первоисточникам. Более свежая дата не доказывает правильность. Недоступные внешние ссылки пометь как непроверенные. Не выполняй для проверки команды установки, развёртывания, изменения данных и удаления.

В первую очередь исправляй ошибки, которые ведут к сбоям при работе или вводят в заблуждение. Если одна проблема затрагивает несколько документов, предложи согласованные правки для всех затронутых мест. Укажи расположение, исходные формулировки, доказательства и практические последствия, затем — полные фрагменты на замену или применимый патч. Короткий документ можно переписать целиком. Избегай косметических правок, сохраняй факты, в которых нет уверенности, и не выдавай незавершённые или непринятые возможности за доступные.

Если материалов много, сначала охвати основные сценарии использования и противоречащие документы, затем явно перечисли непросмотренные области. Не останавливайся на произвольном числе документов и не заявляй об исчерпывающем охвате. Один раз перепроверь правки, пути и названия команд, затем сдай карту документации, готовые правки и непроверенные пункты и остановись.

Условия выполнения:
Начинай сразу. Не проси меня утвердить план, выбрать файлы или заполнить шаблон. Используй только этот проект, этот диалог и уже предоставленные материалы; не ищи в посторонних проектах и в личной истории. Сделай то, что подтверждается данными, и сообщи, каких материалов не хватило. Если задача неприменима, объясни почему и остановись, не выдумывая результат.
Сохраняй существующие файлы и незакоммиченные изменения. Предлагаемое содержимое приводи в ответе полностью; самостоятельные артефакты можно сохранить под новым, незанятым именем файла. Не устанавливай зависимости, не меняй окружение, не делай commit, push и deploy. Соблюдай ограничения доступа и прав и сообщай о работе, которую не удалось выполнить. Проверь результат один раз, сдай его и остановись, не спрашивая, продолжать ли.