Cuestionario vinculado a una guía · Medio Nivel
Prueba de IA para escritores técnicos
Prueba la documentación asistida por IA: documentos como código con Vale y CI, tipos de contenido de Diátaxis, pruebas de ejemplos de código y redacción de documentos para recuperación por IA.
Pregunta 1 de 8
¿Qué hace Vale linter en un flujo de trabajo de documentos como código?
Vista previa de cada pregunta8 preguntas
Las respuestas y explicaciones aparecen a medida que realiza el cuestionario.
- ¿Qué hace Vale linter en un flujo de trabajo de documentos como código?
- 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
- ¿Qué describe mejor los documentos como código?
- 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
- ¿Qué cuatro tipos de contenidos separa el marco Diátaxis?
- Blogs, emails, slides and videos
- Tutorials, how-to guides, reference and explanation
- Drafts, reviews, approvals and archives
- Beginner, intermediate, advanced and expert
- ¿Por qué deberían ejecutarse como pruebas muestras de código generadas por IA?
- 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
- ¿Qué es la propuesta 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
- 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
- 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
- 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