Agent pisze dokumentację.Ty dbasz, by była poprawna.
Gdy dokumentację pisze agent AI, ktoś musi ją sprawdzić. Czytaj każdą stronę sformatowaną, komentuj, gdzie jest błędna, oglądaj każdą zmianę i przywracaj dowolną wersję.
macOS 14 lub nowszy. Czytanie jest bezpłatne, a DotMD Pro ma 3-dniowy bezpłatny okres próbny.
Krótka odpowiedź
Otwórz folder z dokumentacją w DotMD i czytaj każdą stronę sformatowaną. Komentuj tam, gdzie agent się pomylił; poprawi każdy komentarz, a Ty zaakceptujesz zmianę w pliku. Każda wersja jest zachowana, więc możesz porównywać szkice, cofać blok lub przywracać stronę. Historia wersji, wyszukiwanie w folderach i eksport należą do DotMD Pro (3 dni bezpłatnego okresu próbnego).
Folder z dokumentacją, sformatowany
Przeciągnij folder z dokumentacją na DotMD, a stanie się Twoją przestrzenią roboczą. Strony otwierają się w kartach, a pasek boczny wylicza je według tytułu, nie nazwy pliku. Tytuł pochodzi z pola title: we front matter strony albo, gdy go brak, z pierwszego nagłówka. Właściwości pojawiają się jako karta nad stroną.
⇧⌘F przeszukuje nazwy plików i każdy wiersz tekstu we wszystkich folderach przestrzeni roboczej, więc znalezienie strony wspominającej o ustawieniu zajmuje sekundę.
Recenzuj szkice agenta
-
Poproś o stronę jako plik
„Napisz instrukcję instalacji do docs/install.md i wyślij mi ją w DotMD do recenzji”.
-
Komentuj każdy problem
Zaznacz zdanie z błędnym poleceniem lub niejasnym krokiem, naciśnij ⌥⌘M i napisz, jak ma być. Najpierw przejrzyj całą stronę.
-
Wyślij, potem sprawdź poprawki
Kliknij Send. Agent poprawia każdy komentarz, a każda poprawka pojawia się w pliku, stary tekst na czerwono, nowy na zielono, obok swojego komentarza. Accept lub Reopen.
-
Zatwierdź
Gdy nie ma już nic do zmiany, kliknij Approve.
Komentarze przechowuje DotMD, a nie plik, więc Twój Markdown nie ma znaczników ani komentarzy HTML. Podążają za stroną, jeśli zmienisz jej nazwę lub ją przeniesiesz.
Każda wersja do przywrócenia
DotMD zachowuje wcześniejsze wersje każdego otwieranego pliku. Otwórz historię, a każda wersja jest pokazana sformatowana, z tym, co zmieniło się od poprzedniej: dodany tekst na zielono, usunięty na czerwono.
- Revert cofa pojedynczy zmieniony blok, na przykład akapit lub wiersz tabeli, a resztę zostawia.
- Restore przywraca całą wcześniejszą wersję. Bieżący tekst jest najpierw zapisywany jako wersja, więc przywrócenie można cofnąć.
- Pliki zmienione przez inną aplikację, na przykład agenta lub git, dostają w pasku bocznym pomarańczową kropkę. Otwórz taki plik, a DotMD przejdzie od razu do tego, co zmieniło się od Twojego ostatniego czytania.
Plik utworzony przez agenta ma jedną wersję, dopóki nie otworzysz go po raz pierwszy, więc zmiany liczą się od tekstu, który przeczytałeś jako pierwszy.
Gdy otwarty plik zmieni się na dysku, baner pokazuje, ile wierszy dodano i usunięto, a Show Changes otwiera historię w porównaniu z poprzednim tekstem.
Niech drugi agent sprawdzi fakty
Strona może dobrze się czytać i być błędna. Poproś innego agenta o sprawdzenie, a jego uwagi trafią do DotMD jako komentarze z jego imieniem, które zachowasz lub usuniesz, zanim zobaczy je autor:
„Zrecenzuj docs/install.md w DotMD i zostaw komentarze przy każdym poleceniu, które nie działa”.
To cykl opisany w Jeden agent recenzuje drugiego. Moderujesz komentarze, więc autor dostaje tylko uwagi, z którymi się zgadzasz.
Sprawdź, co zobaczą czytelnicy
DotMD rysuje diagramy Mermaid, wzory KaTeX, tabele, calloutsy i kod z kolorowaniem składni, więc czytasz stronę tak, jak będą ją czytać Twoi czytelnicy. Żeby ją przekazać dalej, wyeksportuj do PDF lub HTML, skopiuj jako tekst sformatowany do Poczty, Notatek, Pages lub Google Docs, skopiuj jej źródło HTML na bloga lub do CMS albo wydrukuj.
Pytania pisarzy technicznych
Czy DotMD obsługuje front matter?
Tak. Właściwości pojawiają się jako karta, a title: pliku może nadać mu nazwę w pasku bocznym.
Czy mogę przeszukać cały folder z dokumentacją?
Tak, z DotMD Pro: ⇧⌘F znajduje nazwy plików i każdy wiersz z tekstem we wszystkich folderach przestrzeni roboczej.
Czy mogę wyeksportować stronę?
Tak, z DotMD Pro: PDF, HTML, Copy as Rich Text, Copy HTML Source lub wydruk.
Co dzieje się z komentarzami, gdy plik zostanie przeniesiony?
Wracają, gdy po raz pierwszy otworzysz plik w nowym miejscu.