Агент пишет документацию.Вы следите, чтобы она была верной.

Папка с документацией в оформленном виде

Перетащите папку с документацией на DotMD, и она станет вашим рабочим пространством. Страницы открываются во вкладках, а боковая панель показывает их по заголовку, а не по имени файла. Заголовок берётся из поля title: во front matter страницы, а если его нет, из первого заголовка. Свойства показаны карточкой над страницей.

⇧⌘F ищет по именам файлов и по каждой строке текста во всех папках рабочего пространства, так что найти страницу, где упомянута настройка, можно за секунду.

Docs as code на Mac

Если документация лежит в репозитории Git как Markdown-файлы рядом с кодом (docs as code), DotMD даёт этой папке на Mac и читалку, и инструмент ревью. Откройте папку документации из репозитория как рабочее пространство и читайте каждую страницу в отрисованном виде. Комментарии хранит DotMD, а не файлы, поэтому в коммит они не попадают; то, что меняет агент, — обычная правка .md-файла, готовая к вашему привычному diff и pull request.

Проверяйте черновики агента

1. Попросите страницу файлом

   «Напиши руководство по установке в docs/install.md и пришли мне в DotMD на ревью».

2. Комментируйте каждую проблему

   Выделите предложение с неверной командой или неясным шагом, нажмите ⌥⌘M и напишите, как должно быть. Сначала пройдите всю страницу.

3. Отправьте, затем проверьте правки

   Нажмите Send. Агент исправит каждый комментарий, и каждая правка появится в файле, старый текст красным, новый зелёным, рядом с комментарием. Accept или Reopen.

4. Одобрить

   Когда менять больше нечего, нажмите Approve.

Комментарии хранит DotMD, а не файл, поэтому в вашем Markdown нет ни маркеров, ни HTML-комментариев. Они следуют за страницей, если вы её переименуете или переместите.

Каждая версия, с возможностью восстановить

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

• Revert отменяет один изменённый блок, например абзац или строку таблицы, остальное остаётся.
• Restore возвращает целую прежнюю версию. Текущий текст сначала сохраняется как версия, так что восстановление можно отменить.
• Файлы, которые изменило другое приложение, например агент или git, получают в боковой панели оранжевую точку. Откройте такой файл, и DotMD сразу покажет, что изменилось с вашего последнего чтения.

Файл, созданный агентом, хранит одну версию, пока вы не откроете его впервые, так что изменения считаются от текста, который вы прочитали первым.

Когда открытый файл меняется на диске, баннер показывает, сколько строк добавлено и удалено, а Show Changes открывает историю в сравнении с прежним текстом.

Пусть второй агент проверит факты

Страница может хорошо читаться и всё же быть неверной. Попросите другого агента проверить её, и его замечания придут в DotMD комментариями с его именем: вы оставите или удалите их, прежде чем их увидит автор:

«Проверь docs/install.md в DotMD и оставь комментарии к каждой команде, которая не работает».

Это цикл из раздела Один агент проверяет другого. Вы модерируете комментарии, так что автор получает только те замечания, с которыми вы согласны.

Проверьте, что увидят читатели

DotMD рисует диаграммы Mermaid, формулы KaTeX, таблицы, callout-блоки и код с подсветкой, так что вы читаете страницу так, как будут читать ваши читатели. Чтобы передать её дальше, экспортируйте в PDF или HTML, скопируйте как форматированный текст в Почту, Заметки, Pages или Google Docs, скопируйте её HTML-код для блога или CMS либо распечатайте.

Вопросы технических писателей

Другие вопросы