Braio

Wiedza · dokumentacja

Docs Writer

Pilnuje, żeby dokumentacja nadążała za kodem: czyta zmiany, proponuje poprawki stron, a większe przebudowy oddaje jako pull request. Nigdy nie publikuje sam.

Wejście
pull request albo strona
Wyjście
propozycja zmiany do przeglądu
Czyta
kod · PR-y · dokumentację
Agent Docs Writer

Co robi

Zakres pracy

Co zmiana znaczy dla docs

Czyta pliki z pull requesta i obecną dokumentację, a potem mówi dokładnie, których stron dotyczy zmiana i dlaczego.

Analiza · PR → strony

Poprawki do przeglądu

Zmianę strony w przestrzeni dokumentacji Braio przygotowuje jako propozycję do przeglądu - zmienia tylko to, o co prosisz, a publikację zostawia człowiekowi.

Docs · propozycja, nie publikacja

Większe przebudowy jako PR

Dokumentację w repozytorium albo zmianę w wielu plikach oddaje jako pull request po akceptacji karty zadania - w tonie i strukturze Twoich docs, z cytatem kodu.

Repo · docs as code