Документация проекта

Эта вкладка показывает Markdown-документы, которые находятся в папках документации внутри рабочего пространства. Она предназначена для документации вашего проекта и не совпадает со справочным центром Promto, который открывается через «Помощь».

Откуда берутся документы

Promto ищет папку с точным русским именем Документация:

• непосредственно внутри репозитория: /home/user/<repo>/Документация;
• либо непосредственно в /home/user/Документация.

В карточке документа отображаются имя файла, репозиторий, размер, дата изменения и сокращённый путь.

Как открыть документ

1. Нажмите карточку документа.
2. Файл откроется в подходящем редакторе приложения «Файлы».
3. Чтобы увидеть остальные документы этого репозитория, нажмите Папка.

Карточку можно перетащить в чат. Агент получит ссылку на конкретный файл и сможет использовать его как контекст.

Если документации ещё нет

1. Нажмите Написать документацию.
2. Promto откроет новую вкладку чата с агентом.
3. Агент найдёт релевантные репозитории и подготовит структуру документов.
4. После создания файлов вернитесь во вкладку «Документация» — список обновится автоматически.

Обычно полезно описать:

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

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

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

Инструкции и CLI для агента

Отдельной focused-инструкции с topic documentation и отдельного CLI promto-docs нет. Для этой задачи главный агент использует:

• Promto Runtime Rules — topic runtime;
• Promto UI Markers And User-Facing Paths — topic ui_markers, когда нужно вернуть ссылку OpenFile на готовый документ.

Главный агент загружает их через get_instruction({ topic: "runtime" }) и get_instruction({ topic: "ui_markers" }). get_instruction — встроенный инструмент агента, а не shell-команда. Для анализа проекта агент использует чтение файлов и поиск по репозиторию, затем создаёт обычные .md-файлы. Если нужно проверить занимаемое место, доступен встроенный инструмент promto_disk.

В терминале общий контракт загружается командой promto instructions; для поиска и проверок используются обычные CLI репозитория, а состояние диска проверяется через promto disk. Специальной terminal-команды для генерации документации нет.

Готовый промпт для агента

Сначала вызови get_instruction по теме runtime. Изучи фактическую структуру, конфигурацию, команды запуска, сборки и тестов проекта; не переноси неподтверждённые команды из старых заметок. Создай или обнови релевантные Markdown-файлы непосредственно в папке Документация. Отдели действующие решения от исследуемых вариантов, не добавляй секретные значения. Перед ответом загрузи ui_markers и верни OpenFile для каждого созданного или изменённого документа.

Если файл не появился

• Проверьте, что документ сохранён как Markdown-файл.
• Проверьте, что он находится непосредственно в папке Документация, а не во вложенном или произвольном каталоге.
• Обновите вкладку или вернитесь в неё после завершения работы агента.
• Откройте папку через «Файлы» и убедитесь, что файл действительно создан.