Kvíz spojený s průvodcem · Střední úroveň

Kvíz AI pro technické spisovatele

Testuje dokumentaci podporovanou AI: docs-as-code s Vale a CI, typy obsahu Diátaxis, testování vzorků kódu a psaní dokumentů pro načítání AI.

Související vodicí cestyAI pro technické spisovatele
Otázka 1 z 8

Co dělá linter Vale v pracovním postupu docs-as-code?

Náhled každé otázky8 otázky

Odpovědi a vysvětlení se zobrazují, jak budete v kvízu.

  1. Co dělá linter Vale v pracovním postupu docs-as-code?
    • Generuje referenční stránky API z kódu
    • Hostuje dokumentační web
    • Kontroluje prózu podle pravidel průvodce stylem a pokaždé dává stejný výsledek
    • Překládá dokumenty do jiných jazyků
  2. Co nejlépe popisuje docs-as-code?
    • Dokumentace uchovávaná ve správě verzí a kontrolovaná a sestavovaná jako kód
    • Psaní dokumentace pouze uvnitř komentářů kódu
    • Použití AI k automatickému psaní všech dokumentů
    • Publikování dokumentace pouze ve formátu PDF
  3. Které čtyři typy obsahu odděluje rámec Diátaxis?
    • Blogy, e-maily, diapozitivy a videa
    • Konzultace, návody, odkaz a vysvětlení
    • Koncepty, recenze, schválení a archivy
    • Začátečník, mírně pokročilý, pokročilý i expert
  4. Proč by měly být ukázky kódu generované AI spouštěny jako testy?
    • Testy urychlují načítání stránek
    • Vyhledávače vyžadují testovaný kód
    • Testování nahrazuje potřebu průvodce stylem
    • Modely mohou vymýšlet věrohodné parametry nebo příznaky a testy je zachytí dříve, než čtenáři
  5. Co je návrh souboru llms.txt?
    • Navrhovaný soubor, který odkazuje na jazykové modely na klíčovou dokumentaci webu
    • Legální licence pro výcvik AI
    • Stylový průvodce publikovaný Microsoft
    • Požadovaný formát pro všechny specifikace API
  6. Které psaní pomáhá asistentům umělé inteligence, kteří získávají dokumentaci?
    • Dlouhé stránky bez nadpisů
    • Časté odkazy jako „jak je uvedeno výše“
    • Samostatné sekce s popisnými nadpisy a explicitními názvy produktů
    • Vkládání veškerého obsahu do obrázků
  7. Jak se běžně vytvářela referenční dokumentace API před generativní AI?
    • Vždy se psalo výhradně ručně
    • Byl vygenerován ze specifikací nebo komentářů ke kódu pomocí nástrojů jako Swagger UI, Redoc nebo Sphinx autodoc
    • To neexistovalo
    • Byl vytvořen rozpoznáváním řeči
  8. Kde podle průvodce přidává technický spisovatel největší hodnotu vedle umělé inteligence?
    • Psaní rychleji než model
    • Vyhýbání se kontrole verzí
    • Odebírání všech lidských recenzí
    • Kontrola přesnosti, rozhodování o tom, co uživatelé potřebují, a strukturování informací