Agent píše dokumentaci.Vy ji udržíte správně.

Složka s dokumentací, vykreslená

Přetáhněte složku s dokumentací na DotMD a stane se vaším pracovním prostorem. Stránky se otevírají v panelech a postranní panel je řadí podle titulku, ne podle názvu souboru. Titulek se bere z pole title: ve front matter stránky, jinak z prvního nadpisu. Vlastnosti se zobrazí jako karta nad stránkou.

⇧⌘F hledá v názvech souborů a v každém řádku textu napříč všemi složkami pracovního prostoru, takže najít stránku, která zmiňuje nastavení, trvá vteřinu.

Kontrolujte koncepty agenta

1. Požádejte o stránku jako soubor

   „Napiš instalační příručku do docs/install.md a pošli mi ji v DotMD ke kontrole.“

2. Komentujte každý problém

   Označte větu se špatným příkazem nebo nejasným krokem, stiskněte ⌥⌘M a napište, jak to má být. Nejdřív projděte celou stránku.

3. Odešlete a zkontrolujte opravy

   Klikněte na Send. Agent opraví každý komentář a každá oprava se objeví v souboru, starý text červeně a nový zeleně, vedle svého komentáře. Accept nebo Reopen.

4. Schválit

   Až nebude co měnit, klikněte na Approve.

Komentáře ukládá DotMD, ne soubor, takže váš Markdown neobsahuje žádné značky ani HTML komentáře. Následují stránku, když ji přejmenujete nebo přesunete.

Každá verze, obnovitelná

DotMD uchovává dřívější verze každého souboru, který otevřete. Otevřete historii a každá verze se zobrazí vykreslená, s tím, co se změnilo oproti předchozí: přidaný text zeleně, odebraný červeně.

• Revert vrátí jediný změněný blok, například odstavec nebo řádek tabulky, a zbytek nechá.
• Restore obnoví celou dřívější verzi. Aktuální text se nejdřív uloží jako verze, takže obnovení lze vrátit.
• Soubory, které změnila jiná aplikace, třeba agent nebo git, dostanou v postranním panelu oranžovou tečku. Otevřete takový soubor a DotMD přejde rovnou na to, co se změnilo od vašeho posledního čtení.

Soubor, který vytvoří agent, má jedinou verzi, dokud ho poprvé neotevřete, takže změny se počítají od textu, který jste přečetli jako první.

Když se otevřený soubor změní na disku, banner ukáže, kolik řádků přibylo a ubylo, a Show Changes otevře historii porovnanou s předchozím textem.

Nechte druhého agenta ověřit fakta

Stránka se může dobře číst a přesto být špatně. Požádejte jiného agenta, aby ji zkontroloval, a jeho poznámky přijdou do DotMD jako komentáře s jeho jménem, které si necháte nebo smažete dřív, než je uvidí autor:

„Zkontroluj docs/install.md v DotMD a zanech komentáře u každého příkazu, který nefunguje.“

To je cyklus popsaný v Jeden agent kontroluje druhého. Komentáře moderujete vy, takže autor dostane jen poznámky, se kterými souhlasíte.

Zkontrolujte, co uvidí čtenáři

DotMD vykreslí diagramy Mermaid, vzorce KaTeX, tabulky, callouty a kód se zvýrazněním, takže stránku čtete tak, jak ji budou číst vaši čtenáři. Pro předání ji exportujte do PDF nebo HTML, zkopírujte jako formátovaný text do Pošty, Poznámek, Pages nebo Google Docs, zkopírujte její zdroj HTML pro blog nebo CMS, nebo ji vytiskněte.

Otázky technických pisatelů

Další otázky