30 minutes
How to Utrzymuj dokumentację na bieżąco with Eigent
Wykorzystaj zmiany w kodzie i kontekst PR, aby tworzyć precyzyjne aktualizacje dokumentacji — bez szerokich przepisów i przestarzałych odniesień.
What you need
- aplikacja desktopowa Eigent
- dostęp do codebase (lokalnie lub połączone repozytorium)
- repozytorium dokumentacji lub połączony system dokumentacji
Best for
- Dokumentacja dla deweloperów, README, runbooki i notatki migracyjne dla szybko zmieniającego się codebase
- Zespoły, które utrzymują dokumentację równolegle z częstymi zmianami w kodzie
- Inżynierowie tworzący notatki o wydaniu lub changelog na podstawie scalonych PR
Starter Prompt
Zaktualizuj dokumentację [produktu/funkcji] na podstawie następujących źródeł: - zmienionych plików źródłowych w [tym repo / połączonym repo] - istniejących stron dokumentacji, które wspominają o zmienionym zachowaniu - dowolnego powiązanego issue, PR, notatki do wydania lub publicznego materiału referencyjnego, który podaję poniżej Następnie: - określ, co jest widoczne dla użytkownika - aktualizuj tylko tę dokumentację, która wymaga zmian - nie uwzględniaj w publicznej dokumentacji nieopublikowanej mapy rozwoju, prywatnych danych klientów ani kontekstu przeznaczonego wyłącznie do użytku wewnętrznego - zachowaj istniejącą strukturę dokumentacji, terminologię i linki krzyżowe - uruchom kontrole dokumentacji odpowiednie dla tej zmiany Przed finalizacją podsumuj, co się zmieniło, co zweryfikowałeś i których twierdzeń nie mogłeś potwierdzić na podstawie zaufanych źródeł.
Jak to działa
- Udostępnij zmienione pliki źródłowe, gałąź, pull request lub commit, który trzeba udokumentować.
- Poproś Eigent, aby przeszukał istniejącą dokumentację pod kątem nazw funkcji, kluczy konfiguracji, poleceń i przykładów, których dotyczy zmiana.
- Aktualizuj tylko dokumentację, która wymaga zmian — zachowaj strukturę strony, terminologię, linki krzyżowe i frontmatter.
- Uruchom formatowanie i kontrole dokumentacji, a następnie poproś Eigent o podsumowanie dowodów stojących za każdym twierdzeniem widocznym dla użytkownika.
- Przejrzyj podsumowanie przed publikacją, aby potwierdzić, że do publicznej dokumentacji nie trafiły żadne wewnętrzne ani nieopublikowane informacje.
Więcej promptów do wypróbowania
- Które istniejące strony dokumentacji odwołują się do zachowania zmienionego w tym PR?
- Czy ta zmiana wpływa na jakieś publiczne parametry API, wartości domyślne lub flagi CLI, które trzeba zaktualizować?
- Napisz wpis do changelogu dla tego wydania zgodny z naszym obecnym formatem.
- Zidentyfikuj wszelkie twierdzenia widoczne dla użytkownika w zaktualizowanej dokumentacji, których nie możesz zweryfikować wyłącznie na podstawie kodu źródłowego.
Jak używać
Zacznij od zmiany, którą trzeba udokumentować — udostępnij gałąź, PR lub commit. Poproś Eigent, aby najpierw przeszukał istniejącą dokumentację, zanim cokolwiek zacznie pisać, aby zaktualizował właściwe strony zamiast tworzyć nowe i duplikujące istniejącą zawartość. Utrzymuj wąski zakres: precyzyjna notatka lub aktualizacja przykładu jest lepsza niż przepisywanie całej strony. Aby uczynić to powtarzalnym, zapisz workflow jako skill lub poproś Eigent, aby uruchamiał go według harmonogramu po każdym wydaniu.
Oczekiwany wynik
Zaktualizowane pliki dokumentacji obejmujące wyłącznie zmiany widoczne dla użytkownika, podsumowanie tego, co zostało zmienione i zweryfikowane, oraz lista wszelkich twierdzeń, których nie można było potwierdzić na podstawie zaufanych źródeł i które wymagają ręcznej weryfikacji.
Ograniczenia
- Eigent nie ma dostępu do prywatnych danych klientów, nieopublikowanych elementów mapy rozwoju ani wewnętrznych wiki, chyba że wyraźnie je udostępnisz.
- Dokładność dokumentacji zależy od jakości komentarzy w źródłach i pokrycia testami — nieudokumentowane zachowanie może zostać pominięte.
- Bardzo duże witryny dokumentacyjne korzystają na ograniczeniu wyszukiwania do konkretnej sekcji lub obszaru funkcji zamiast do całej witryny.
Related workflows
Zapisz workflow jako umiejętności
Zamień działający wątek w Eigent, reguły przeglądu, komendy testowe lub checklisty wydania w ponowni…
Przeglądaj pull requesty GitHub
Wykrywaj regresje, brakujące testy i ryzykowne zmiany zachowania przed ludzkim przeglądem — automaty…
Refaktoryzuj swój codebase
Usuń martwy kod i unowocześnij przestarzałe wzorce bez zmiany działania — w małych, możliwych do zre…
