polyshComprobador de legibilidad de documentación
Obtén la facilidad de lectura Flesch y el nivel escolar de cada sección.
- Funciona en tu navegador
- Sin subidas
- Sin cuenta
Esta herramienta analiza texto en inglés.
Cargando tu herramienta del navegador…
Qué hace Comprobador de legibilidad de documentación
Las fórmulas de legibilidad convierten la longitud de las frases y de las palabras en una puntuación. Pega un artículo de ayuda, un SOP o una página de documentación en inglés para obtener la facilidad de lectura Flesch (Flesch Reading Ease), donde más alto es más fácil, y el nivel escolar Flesch-Kincaid, donde más bajo es más fácil, para todo el texto y para cada sección bajo su encabezado.
La tabla de secciones es lo que lo hace útil para documentos largos: una sola sección densa de arquitectura puede arrastrar una guía fácil de leer al rango difícil, y las secciones por debajo de 50 se marcan en negrita. Los bloques de código y los encabezados quedan fuera, así que una página llena de ejemplos no sale penalizada. Las frases que superan el límite, 25 palabras de forma predeterminada, se cuentan en su propio recuadro.
Ejemplo
Entrada
## Quick start Open the app. Click New video. Pick a recording from your library. ## How rendering works The renderer combines your recording, the generated voiceover, and the caption track into a single file. Larger projects take longer because every frame is processed again.
Resultado
Reading ease: 52.2 (fairly difficult) Grade level: 7.9 Quick start: ease 69, grade 4.7 How rendering works: ease 41, grade 10.8
La sección Quick start, de frases cortas, se lee con facilidad; las palabras más largas de la segunda sección dejan la puntuación global por debajo de 60.
Cómo usar Comprobador de legibilidad de documentación
- Pega el documento con sus encabezados o pulsa “Usar ejemplo”.
- Ajusta “Marcar frases de más de” al máximo de palabras por frase que permita tu guía de estilo.
- Empieza a revisar por las filas en negrita de la tabla “Sección”, “Facilidad”, “Nivel” y “Palabras”.
Conviene saber
- Las sílabas se estiman con reglas y una lista de excepciones, así que los nombres de producto y los términos técnicos pueden subir o bajar la puntuación unos puntos.
- Las secciones muy cortas dan puntuaciones inestables, porque una sola palabra larga puede hacer que la puntuación de una sección de dos frases varíe muchos puntos. Valora las secciones de 100 palabras o más.
- Las puntuaciones pueden bajar de cero en textos técnicos densos. Así funciona la fórmula de Flesch, no es un error.
- Las puntuaciones de legibilidad miden la longitud de las frases y de las palabras, no la claridad. Para encontrar palabras vagas y pasos con varias acciones, usa el Comprobador de complejidad de instrucciones.
Preguntas sobre Comprobador de legibilidad de documentación
¿Cuál es una buena puntuación de Flesch Reading Ease?
De 60 a 70 es inglés claro que la mayoría de los adultos leen con comodidad, y es un buen objetivo para contenido de ayuda. De 70 en adelante es fácil. Por debajo de 50 es bastante difícil, y por debajo de 30 se lee como un texto académico. La documentación técnica suele quedar entre 40 y 59.
¿Para qué nivel escolar se debe escribir la documentación?
Apunta a un nivel 8 o inferior en centros de ayuda, incorporación y SOP. La documentación para desarrolladores suele estar en los niveles 9 a 12 por los términos técnicos, pero mantener las frases cortas sigue ayudando a quien no tiene el inglés como lengua materna.
¿Cómo se calcula el nivel Flesch-Kincaid?
Es 0,39 multiplicado por la media de palabras por frase, más 11,8 multiplicado por la media de sílabas por palabra, menos 15,59. Reading Ease usa los mismos dos datos con otros pesos. Tanto las frases cortas como las palabras cortas mejoran la puntuación.
¿Cómo hago que un SOP sea más fácil de leer?
Deja cada paso en una acción, empieza cada uno con un verbo, usa las palabras que de verdad usa tu equipo y lleva los antecedentes a una sección aparte. Comprueba aquí la puntuación y revisa primero las secciones con menor facilidad.