Kuiz berkaitan panduan · Sederhana Tahap

Kuiz AI untuk Penulis Teknikal

Menguji dokumentasi berbantukan AI: docs-as-code dengan Vale dan CI, jenis kandungan Diátaxis, sampel kod ujian dan menulis dokumen untuk pengambilan AI.

Laluan panduan yang berkaitanAI Untuk Penulis Teknikal
soalan 1 daripada 8

Apakah yang dilakukan oleh linter Vale dalam aliran kerja docs-as-code?

Pratonton setiap soalan8 soalan

Jawapan dan penjelasan muncul semasa anda mengambil kuiz.

  1. Apakah yang dilakukan oleh linter Vale dalam aliran kerja docs-as-code?
    • Generates API reference pages from code
    • Hosts the documentation website
    • Checks prose against style-guide rules and gives the same result every time
    • Translates docs into other languages
  2. Apakah yang terbaik menerangkan docs-as-code?
    • Documentation kept in version control and reviewed and built like code
    • Writing documentation only inside code comments
    • Using AI to write all docs automatically
    • Publishing documentation as PDF only
  3. Empat jenis kandungan manakah yang dipisahkan oleh rangka kerja Diátaxis?
    • Blogs, emails, slides and videos
    • Tutorials, how-to guides, reference and explanation
    • Drafts, reviews, approvals and archives
    • Beginner, intermediate, advanced and expert
  4. Mengapakah sampel kod yang dijana AI harus dijalankan sebagai ujian?
    • Tests make pages load faster
    • Search engines require tested code
    • Testing replaces the need for a style guide
    • Models can invent plausible parameters or flags, and tests catch them before readers do
  5. Apakah cadangan llms.txt?
    • A suggested file that points language models to a site's key documentation
    • A legal license for AI training
    • A style guide published by Microsoft
    • A required format for all API specs
  6. Which writing practice helps AI assistants that retrieve documentation?
    • Long pages with no headings
    • Frequent references like 'as mentioned above'
    • Self-contained sections with descriptive headings and explicit product names
    • Putting all content in images
  7. How was API reference documentation commonly produced before generative AI?
    • It was always written entirely by hand
    • It was generated from specs or code comments with tools such as Swagger UI, Redoc or Sphinx autodoc
    • It did not exist
    • It was produced by speech recognition
  8. According to the guide, where does a technical writer add the most value alongside AI?
    • Typing faster than the model
    • Avoiding version control
    • Removing all human review
    • Checking accuracy, deciding what users need and structuring information