Localización de software: La Documentación Electrónica PDF

Localización de software: la documentación en formato electrónico Nociones básicas Estrategias habituales Herramientas esenciales El proceso y sus fases 1  1. Nociones básicas docu...

Localización de software: la documentación en formato electrónico Nociones básicas Estrategias habituales Herramientas esenciales El proceso y sus fases 1  1. Nociones básicas documentar un producto acompañarlo de todas aquellas informaciones necesarias para describir, explicar, ilustrar, comentar... sus características y su funcionamiento, incluidos su instalación (y desinstalación) y mantenimiento 2  Clasificación componentes documentación Según la función: – descriptivos: comentarios del código, especificaciones técnicas, notas de la versión, historial de versiones, registro de modificaciones, archivos README, etc. – operativos: guías y manuales, sistemas de ayuda, tutoriales, tarjetas sinópticas, preguntas frecuentes, glosarios, etc.; – ilustrativos: archivos de ejemplo, plantillas y maquetas prediseñadas, etc.; – comerciales: embalaje del producto, folletos, pegatinas, material serigrafiado, etc.; – y legales: contratos de licencia, garantías y similares. Según su(s) destinatario(s): – documentos descriptivos y operativos dirigidos al usuario final – y/o a un usuario especializado (programador, administrador de redes, técnico de mantenimiento, etc.) Según el soporte físico: – papel – formato electrónico 3  Tendencia actual proliferación de formatos multimedia y nuevos soportes publicación en diversos formatos a partir de una fuente común (Single Source Publishing) elemento central de su documentación electrónica: sistema de ayuda, ayuda en línea o ayuda Formatos: Apple Guide, Microsoft Help 2, HTML Help (CHM), JavaHelp, Assistance Platform Help (MAML), Texinfo, WebHelp y WinHelp (HLP). 4  Elementos básicos del sistema de ayuda Elementos: – índice de contenido (table of contents); – panel central de contenido (topic window); – índice de palabras clave (keywords) y buscador; – iconos, botones, pestañas u opciones de menú. Ejecución: – Tecla de función F1 – Opción de menú al efecto (por lo general, Ayuda o ?). – Botón o icono en otros lugares de la interfaz del programa, como los cuadros de diálogo. – Cursor en forma de signo de interrogación de cierre (ayuda contextual [context-sensitive help]), o al situar el puntero sobre un determinado lugar de la pantalla (mouse-over help). 5  2. Estrategias habituales Estrategia depende de: – naturaleza (arquitectura informática, envergadura y complejidad, volumen y distribución del texto, etc.), – relación con el cliente (que puede o no facilitar los archivos fuente sin compilar, e incluso herramientas o utilidades desarrolladas ad hoc), – recursos materiales y humanos disponibles →Volumen: uno o varios profesionales →Localización integral o parcial →archivos compilados (hlp, chm), formato descompilado (.rtf,.html,.xml) o en uno de intercambio (.xliff) →práctica del Single Source Publishing: falta del contexto visual 6  3. Herramientas esenciales herramienta de edición de sistemas de ayuda (Help Authoring Tools (HAT)) herramientas de traducción asistida y de localización 7  4. Proceso y sus fases [descompilación]; localización de los componentes textuales, hipertextuales y gráficos; [compilación]; comprobación (testing), depuración (debugging) y control de calidad. 8  Sistemas de ayuda en formato CHM Arevalillo, 2004 9 archivos descripción ¿localizable?.HTM(L) contenido textual e hipertextual de los sí (con un gestor de memorias de traducción o herramienta temas del sistema de ayuda de localización, o con cualquier programa que permita procesar lenguajes de etiquetado).BMP,.GIF, imágenes sin capas del sistema de sí (siempre que contengan texto traducible o se trate de.JP(E)G y ayuda que a menudo corresponden a imágenes localizables):.PNG capturas de la interfaz del programa, que requieren escasa resolución; a veces las capturas de pantalla, con un programa especializado o (JPEG) se trata de imágenes con la ayuda del teclado [tecla ImprPant combinada o no fotográficas o pseudofotográficas que con ALT]); requieren una resolución superior las demás imágenes, con un programa de tratamiento de imágenes o con el propio editor de imágenes que incluye la herramienta HAT utilizada para localizar el sistema de ayuda.HHC Html Help Contents sí (con un editor de textos, una herramienta HAT o una de índice de los temas del sistema de localización) ayuda.HHK Html Help Keywords sí (con un editor de textos, una herramienta HAT o una de índice de palabras clave definidas como localización) tales en cada tema de ayuda.HHP Html Help Project puede ser necesario realizar pequeños ajustes (con un editor archivo del proyecto con los parámetros de textos, una herramienta HAT o una de localización) del sistema de ayuda necesarios para compilarlo 10  Otros componentes localizables archivos de texto sin formato (text-only) - documentos README (LÉAME o LÉEME) - historiales de versiones (version history) o de modificaciones (change log) del producto - archivos funcionales como los de extensión INI (parámetros configuración…) - también la documentación legal (licencia, garantía, etc.) módulos accesorios como subprogramas, filtros, tutoriales, ejemplos, plantillas, complementos, etc. 11  Referencias AREVALILLO DOVAL, JUAN JOSÉ: «Especial Localización». En: La linterna del traductor, núm. 8, 2004, 38-43 [http://traduccion.rediris.es/8/index.htm]. CORBIN, MICHELLE: «Design Checklists for Online Help». En: WinWriters UA, Training and Information for User Assistance Professionals, [www.winwriters.com/articles/checklist/index.html]. ESSELINK, BERT: A Practical Guide to Localisation. Amsterdam/Filadelfia, John Benjamins, 2000, 165-287. http://hat-matrix.com: portal monográfico sobre herramientas de creación de sistemas de ayuda HAT (Help Authoring Tools). www.g2meyer.com/usablehelp: página personal de especialista en sistemas de ayuda. www.helpmaster.info: repertorio de herramientas y otros recursos para la creación y tratamiento de sistemas de ayuda en diversos formatos. 12