Quiz połączony z przewodnikiem · Średni Poziom
Quiz AI dla pisarzy technicznych
Testuje dokumentację wspomaganą sztuczną inteligencją: dokumenty w postaci kodu z Vale i CI, typy treści Diátaxis, testowanie próbek kodu i pisanie dokumentów do wyszukiwania AI.
Pytanie 1 z 8
Co robi linter Vale w przepływie pracy opartym na dokumentach jako kodzie?
Podgląd każdego pytania8 pytania
Odpowiedzi i wyjaśnienia pojawiają się w miarę rozwiązywania quizu.
- Co robi linter Vale w przepływie pracy opartym na dokumentach jako kodzie?
- Generuje strony referencyjne API z kodu
- Prowadzi witrynę internetową z dokumentacją
- Sprawdza prozę zgodnie z zasadami przewodnika po stylu i za każdym razem daje ten sam wynik
- Tłumaczy dokumenty na inne języki
- Co najlepiej opisuje dokumenty jako kod?
- Dokumentacja przechowywana w systemie kontroli wersji oraz sprawdzana i budowana jak kod
- Pisanie dokumentacji tylko w komentarzach do kodu
- Korzystanie ze sztucznej inteligencji do automatycznego pisania wszystkich dokumentów
- Publikowanie dokumentacji wyłącznie w formacie PDF
- Jakie cztery typy treści oddziela framework Diátaxis?
- Blogi, e-maile, slajdy i filmy
- Samouczki, poradniki, odniesienia i wyjaśnienia
- Projekty, recenzje, zatwierdzenia i archiwa
- Początkujący, średniozaawansowany, zaawansowany i ekspert
- Dlaczego próbki kodu wygenerowane przez sztuczną inteligencję należy uruchamiać jako testy?
- Testy sprawiają, że strony ładują się szybciej
- Wyszukiwarki wymagają przetestowanego kodu
- Testowanie zastępuje potrzebę posiadania przewodnika po stylu
- Modele mogą wymyślać wiarygodne parametry lub flagi, a testy wychwytują je, zanim zrobią to czytelnicy
- Jaka jest propozycja pliku llms.txt?
- Sugerowany plik, który wskazuje modele językowe na kluczową dokumentację witryny
- Licencja prawna na szkolenie AI
- Przewodnik po stylu opublikowany przez Microsoft
- Wymagany format wszystkich specyfikacji API
- Która praktyka pisania pomaga asystentom AI w odzyskiwaniu dokumentacji?
- Długie strony bez nagłówków
- Częste odniesienia typu „jak wspomniano powyżej”
- Samodzielne sekcje z opisowymi nagłówkami i wyraźnymi nazwami produktów
- Umieszczenie całej treści na obrazach
- W jaki sposób dokumentacja referencyjna API była powszechnie tworzona przed generatywną sztuczną inteligencją?
- Zawsze był pisany całkowicie ręcznie
- Został wygenerowany na podstawie specyfikacji lub komentarzy do kodu za pomocą narzędzi takich jak Swagger UI, Redoc lub Autodoc Sphinx
- To nie istniało
- Został on wyprodukowany przez rozpoznawanie mowy
- Według przewodnika, gdzie obok sztucznej inteligencji autor tekstów technicznych wnosi największą wartość dodaną?
- Pisze szybciej niż model
- Unikanie kontroli wersji
- Usuwanie wszystkich weryfikacji ręcznych
- Sprawdzanie dokładności, decydowanie, czego potrzebują użytkownicy i porządkowanie informacji