Gran escritura técnica: Mejorar las búsquedas de documento



Palabras clave:


escritura técnica, documentos de usuario, búsqueda de documentos






Cuerpo del artículo:


VISIÓN GENERAL




Búsquedas en documentos de usuario (manuales, etc.) a menudo no porque el lector utiliza palabras diferentes para un concepto que utiliza el autor. Desde palabras del lector no aparecen en el documento, el mecanismo de búsqueda de documento, no puede encontrar en frustración. Este artículo describe una técnica fácil de usar para mejorar las búsquedas, sin tener que cambiar el comportamiento de los usuarios o el software de búsqueda.




DE PALABRAS LOS LECTORES




Personas utilizan las palabras que saben cuando hablan, escritura o búsqueda. Su locura para tratar de obligar al lector a utilizar terminología del escritor; el lector simplemente no podría conocer el término "adecuado". Obligados a usar palabras desconocidas, el lector encontrará el documento de usuario para ser arrogante, o al menos difíciles de utilizar.




Por ejemplo, un Manual de usuario para un programa de procesamiento de textos probablemente utilizará la palabra "formato" cuando se trata con fuentes de carácter y tamaño, así como el diseño de página. Pero supongamos que el lector utiliza la palabra "apariencia" para referirse a estos temas. ¿Cómo podemos conseguir el mecanismo de búsqueda para proporcionar el resultado correcto si el lector busca "apariencia"?




LA RESPUESTA TÉCNICA: UNA BÚSQUEDA DE SINÓNIMOS




La solución técnica sería convertir el software de búsqueda de documentos de ser una búsqueda "término exacto" para una "búsqueda de sinónimos". En una búsqueda de sinónimos, el usuario introduce una palabra que sabe y, a continuación, la búsqueda devuelve referencias a los sinónimos o sinónimos en el documento. Por lo tanto un correctamente configurado de búsqueda de sinónimos debe devolver las referencias a "formato" si el lector busca "apariencia".




Lamentablemente, la búsqueda de sinónimos es rara vez disponible, y crearlo requeriría cambios en el programa de búsqueda existente. Una solución de baja tecnología puede ser la mejor respuesta.




LA RESPUESTA: SINÓNIMOS




Esta técnica, debe poner los sinónimos de la palabra del autor ("formato") en las páginas que desea que la búsqueda para encontrar. Tales sinónimos pueden incluir "apariencia", "diseño" y "diseño". Esta es una solución simple y eficaz.




Puede encontrar sinónimos apropiados utilizando el diccionario de sinónimos que es un componente de la mayoría de los procesadores de texto y de muchas bibliotecas. Seleccione los que los lectores puedan utilizar sinónimos. "Probable que utilice" se basa en el análisis de su lector.




Esto nos lleva a la siguiente pregunta: ¿cómo poner los sinónimos en la página?




NO UTILICE TEXTO OCULTO




Técnicamente escritores expertos pueden preguntar "por qué no usar ocultado texto para los sinónimos?" El beneficio es que el texto oculto no se "desorden" la página.




Así que, si en las secciones del documento de usuario donde se presenta el "formato", el escritor pone la palabra "apariencia" como texto oculto (suponiendo que la utilidad de búsqueda sería encontrar esta información oculta), entonces ocurrirá lo siguiente:




1. El lector busca "apariencia".




2. La búsqueda lleva al lector a la sección "formato" del documento.




3. El lector se pregunta "Cómo obtuve aquí?" La palabra que busca ("apariencia") no aparecen en la página, ya que está oculto.




Dado que es un objetivo de un documento de usuario responder a preguntas del lector, luego haciendo todo lo hace a formular otra pregunta ("cómo obtuve aquí?") es contraproducente. Sinónimos ocultos no son la mejor respuesta.




LA SOLUCIÓN ELEGANTE: "USTED PUEDE SABERLO AS..."




Ocultar los sinónimos no es una buena idea. Es mejor dejar que el lector sabe lo que está sucediendo. La forma más sencilla es agregar una línea de texto en la página donde aparece el tema. Esta línea de texto comienza con la frase, "puede saberlo como..."




Para continuar con nuestro ejemplo "formato", se vuelve nuestra frase sinónimo explicativo, "Usted puede saberlo, aspecto, diseño o diseño." Una búsqueda de "apariencia" lleva al lector a la sección de "Formato".




Al ver la frase "Puede saberlo, aspecto, diseño o diseño", el lector sabe por qué la búsqueda encuentra esta ubicación. La búsqueda satisfecho al lector y no ha agregado la incertidumbre a la situación.




LA LÍNEA DE FONDO




El objetivo de todos los documentos de usuario buena es mejorar la experiencia del lector con el producto. Mediante el uso de sinónimos de términos "técnicos", el escritor hace más eficaz, búsquedas de documento del lector desde los temas necesarios se encontrará con palabras del lector.




No ocultando los sinónimos, el lector no se confunde a por qué llegó a ese lugar en el documento. El resultado es una mejor experiencia con el documento y el producto.