Para muchos desarrolladores de software creación de la documentación técnica no es tarea fácil. En primer lugar, porque esto implica una cuidadosa y trabajo aburrido, que puede durar semanas. Para describir la aplicación, que deben dar un paseo por sus funciones, hacer un montón de capturas de pantalla, que se inserta en un documento de texto, añadir descripciones, explicaciones, leyendas y anotaciones, trabajar sobre la estructura de…

Lo que se necesita para crear archivos de ayuda? La mayoría utilizan para ello el botón PrntScr y un editor de texto. Pero en realidad se puede renunciar y que de otro. Hay programas y servicios de la web, la existencia de la que muchos de los desarrolladores (y incluso los redactores de la documentación técnica) simplemente no se dan cuenta. Soluciones especializadas para la creación de manuales, guías de usuario y otros documentos semejantes unen, como regla, un editor de texto, con un conjunto mínimo de funciones, la aplicación para crear capturas de pantalla, así como las herramientas para la exportación de formatos de documentos. Además, algunos de estos programas hacen la mayor parte del trabajo por el usuario, independientemente poniendo capturas de pantalla en la secuencia correcta, e incluso añadiendo descripción. Veamos cinco de los más exitosos — en nuestra opinión.

Clarify 2.0.5 – rápidos manuales, sin necesidad de software

  • Desarrollador:Blue Mango Learning Systems.
  • Sistema operativo: Windows/Mac.
  • Distribución: shareware, $30.
  • Interfaz de rusia: no.

Si hablamos en el sentido más amplio, Clarify es un editor de texto, en la que se le han añadido herramientas para crear capturas de pantalla. Sin embargo, detrás de esta sencilla frase se esconden muchas horas de tiempo, que pueden ser economizar los productores de la documentación técnica. Gracias Clarify no es necesario cambiar continuamente entre las dos aplicaciones y perder el tiempo en el recuadro de capturas de pantalla – todo recogido en un solo lugar.

La ventana del programa está dividida en dos partes: a la izquierda va el trabajo con los títulos, y el de la derecha con el contenido del manual. Cada título se denomina aquí «paso». Una vez que el autor crea un nuevo título, el programa inmediatamente sugiere que para él es necesario crear una captura de pantalla y agregar texto alternativo. Cada nuevo título se numera automáticamente, también puede fácilmente crear subtítulos, también numerados. Sin embargo, si su documento, los números de las particiones no son necesarios, esta función se puede desactivar. Utilizando la combinación de teclas títulos pueden moverse rápidamente entre las secciones.

Para agregar una captura de pantalla en cualquier lugar de la documentación, basta con seleccionar el título que desee y hacer clic en el botón de captura de pantalla. Si las capturas de pantalla se han creado anteriormente, se puede agregar en el documento, especificando la ruta de acceso a él en el disco. La captura de pantalla se puede hacer de forma inmediata, y con un poco de retraso (hasta cinco segundos), lo que puede ser útil si necesita hacer una captura de pantalla de menú desplegable, o de otro elemento de la interfaz, que no es constante se muestra en la pantalla. Pulsando la tecla «barra Espaciadora», puede alternar entre la captura de pantalla de toda la pantalla o de la ventana actual. Además de esto, existen teclas de acceso rápido para activar/desactivar la visualización del cursor y para capturar el ámbito del mismo tamaño que la anterior captura de pantalla. La última función es muy útil, si es necesario hacer decenas de objetos del mismo tipo de capturas de pantalla, ya que de esta manera se ahorra tiempo en la selección, el área requerida.

Resultante de la captura de pantalla de inmediato se inserta en el tema de la documentación, que fue seleccionado. Lo que es interesante: en el panel de navegación de los puntos para los cuales ya se han agregado las capturas de pantalla, visualmente marcados. Debido a esto, puede de inmediato determinar en qué secciones debe trabajar más.

Entonces, ¿en qué formato se guarda la captura de pantalla, se define en la configuración de la aplicación. El programa puede generar automáticamente las etiquetas ALT para las imágenes, hacer zoom cuando se inserta en el documento al tamaño deseado (la copia original también se conserva), añadir un marco, skruglyat borde.

En Clarify tiene las herramientas básicas para el trabajo con imágenes y texto. Así, las imágenes pueden rotar, recortar, añadir en ellas etiquetas de texto o comentarios, flechas, rectángulos y otros objetos gráficos que pueden ser útiles para visualizar la selección de las áreas en la captura de pantalla.

Cuando se trabaja con texto, puede utilizar listas numeradas y con viñetas, pegar el código, los hipervínculos, la sangría. Para algunos idiomas, trabaja revisar gramática mientras escribe, tiene la función de búsqueda y reemplazo de datos en el documento.

Sobre los proyectos de Clarify se puede trabajar en colaboración con otros usuarios. Para ello es necesario crear una cuenta en el sitio Clarify-it.com. Además, este programa es compatible con los servicios de Dropbox y Evernote, da la posibilidad de exportar los proyectos en formato PDF, Word, HTML y sitios web de WordPress. Si lo desea, también puede simplemente copiar todo el texto del documento (en el mismo texto con imágenes) en el portapapeles.

Al exportar, puede elegir el tema, agregar encabezados y pies de página, controlar diferentes parámetros de visualización (dependiendo del formato). Por ejemplo, para exportar a Word están disponibles tres temas y listo el documento presentado en forma ideal con un formato de archivo con estilos, encabezados, listas, hipervínculos. Tal es un placer, especialmente si recordar cuánto tiempo se debe gastar en similar formato en Word de forma manual.

También es interesante la opción de exportación de todas las imágenes en la carpeta. Cuando este Clarify guarda todos los utilizados en el documento de la imagen en la carpeta especificada y le da a cada archivo un nombre que coincide con la cabecera de la sección a la que se adjunta.

Dr.Explain 5.3 – semi-manuales preparados para anotaciones

  • Desarrollador: Indigo Byte Systems.
  • Sistema operativo: Windows.
  • Distribución: shareware, de 7 de 500 rublos.
  • Interfaz de comer.

Dr.Explain no puede presumir de lo moderno, la interfaz, como Clarify, sin embargo, este programa tiene sus propias y únicas características. Tal vez lo más importante es la automatización del proceso de creación de la documentación técnica. Simplemente especifique la ventana de la aplicación o la página web del servicio, que deben describirse, y el Dr.Explain genere una captura de pantalla, analizará todos los elementos de la interfaz, añadirá llamadas y aun firmará hasta donde sea posible.

Si en la interfaz de zahvatyvaemogo de la aplicación se reunirá con el menú, Dr.Explain abrirá obligatoriamente, hará la foto de todos los niveles de submenú y añade la directriz para cada elemento. Además, todas las capturas de pantalla se colocarán en el proyecto de Dr.Explain con la conservación de la estructura del documento (es decir, digamos, la ventana principal será en la sección 1, que se revela a la carta – 1.1, y las opciones de los submenús – 1.1.1, 1.1.2 y así sucesivamente). Por lo tanto, todo aburrido y monótono el trabajo se ejecuta en modo silencioso, y sólo tiene que añadir una descripción de todos los elementos de la interfaz. Está claro que la estructura de un documento, puede modificar moviendo los puntos, añadiendo y eliminando los innecesarios.

Antes de la creación de capturas de pantalla se puede configurar multitud de parámetros que se refieren a las imágenes. Por ejemplo, existe la posibilidad de especificar la ubicación de los globos, el estilo de anotación, determinar la opción de generación de nombres de archivos (en conformidad con los títulos de las secciones o los números).

Si el trabajo anterior sobre la documentación llevado a cabo en otra aplicación, puede importar fácilmente el proyecto y el programa. Dr.Explain es compatible con la importación de documentos de CHM, Word, HTML, HLP, RTF, TXT, XML.

La colaboración y el trabajo sobre la documentación está organizada a través del servicio de Tiwri.com creado especialmente para el intercambio de datos entre los usuarios de Dr.Explain. Desde la ventana de programa se puede descargar el proyecto actual en el servidor, enviar los cambios, el alivio de la edición, el seguimiento de la historia.

Para la exportación de acabados de la documentación se ofrecen formatos de CHM, Word, PDF y HTML. Incluso antes de realizar la exportación se puede ver como el manual se verá en uno de estos formatos. Antes de exportar, no hay que olvidar para ir a la configuración del proyecto y establecer los parámetros adicionales. Por ejemplo, al guardar un documento en PDF se puede especificar palabras clave, autor, título, tema y formato, configurar el encabezado y pie de página y la numeración de las páginas, así como la creación de marcadores para las secciones. Al exportar a HTML, tiene la posibilidad de configurar el mapa del sitio, agregar comentario para los usuarios de Facebook y Disqus, activar el panel con los botones de las redes sociales, indicar los datos del servidor FTP al que se carga con el proyecto.

Por último, vale la pena prestar atención a lo que el Dr.Explain – producto nacionales de los desarrolladores, por lo que es previsible que en él se puede encontrar un completo soporte para el idioma ruso.

Manula – transferencia de los manuales en línea

  • Desarrollador: Bitz & Pixelz.
  • Sistema operativo: cualquier.
  • Distribución: por suscripción (de $10 al mes).
  • Interfaz de rusia: no.

A principios de 2009, alvin Hogerdayk (Alwin Hoogerdijk), creador de la familia de aplicaciones de contabilidad de las colecciones Collectorz.com decidió crear para sus programas de ayuda en línea. Estaba cansado, que a menudo tienen que aplazar el lanzamiento de nuevas versiones de los programas debido a que aún no están preparados para los cambios en la documentación del usuario o, por el contrario, hacer nuevas versiones disponibles para su descarga desde fuera de fecha de referencia de los archivos y, a continuación, producir nuevos bildy que actualizar manuales.

Para hacer el proceso de complementar la documentación más conveniente para los desarrolladores, y el acceso a ella es más rápida para los usuarios, alvin quería mover todo en la línea. Él comenzó a buscar un sistema de gestión de contenidos, destinada a la creación de la documentación técnica. Y cuando vio que no existe tal cosa, el desarrollador ha creado su propio sistema para su familia de aplicaciones. Más tarde se convirtió en el más universal de producto comercial Manula.com.

Manula.com da la posibilidad de crear y actualizar manuales en el navegador, sin la necesidad de utilizar aplicaciones de escritorio. La ventaja principal del manual es una actualización instantánea. Como sólo los desarrolladores han hecho el cambio, la actualización de los archivos de referencia ya están disponibles a los usuarios — no hay nada exportar, subir al servidor los archivos HTML y así sucesivamente. Cuando manuales se ven igual de bien en cualquier dispositivo – en monitores de gran tamaño, tabletas o teléfonos inteligentes. El servicio se realiza automáticamente la adaptación al tamaño de la pantalla.

Y si el usuario desea obtener una copia de la guía para el offline ver, hacer esto es muy fácil. Manula ofrece una útil la descarga de manuales, creados en su plataforma, en formato PDF.

En el Manula también tiene herramientas para dar cuenta de los cambios y obtener comentarios de los usuarios. Se les invita a evaluar los temas de referencia en el mundo de la documentación. Para los desarrolladores mostrar las estadísticas de las evaluaciones y el número de visitas a las diferentes secciones del manual. Gracias a esto, siempre se puede saber en qué lugar del manual es necesario mejorar, hacer más detallado o enlazar con otras secciones.

Manuales creados con el Manula, tienen un sistema integrado de búsqueda — son los títulos de las secciones, el contenido de la documentación, así como definidos por el desarrollador palabras clave. El servicio mantiene un historial de las consultas de búsqueda y muestra a los desarrolladores de consultas populares, por lo que es fácil de realizar cambios en los títulos y palabras clave.

Una de las características más interesantes Manula – función Topic Sharing. Si la empresa tiene varios objetos del mismo tipo de productos, los fragmentos de la ayuda que usted puede hacer para nihobshcimi. La principal diferencia de la simple copia de las áreas de la documentación en el hecho de que cuando se utiliza la función Topic Sharing modificar necesita en un solo lugar. Cuando este en todas las aplicaciones, la documentación se actualizará de forma automática. Aún más ayudan a automatizar el proceso de las variables (por ejemplo, {APPNAME}), que se configuran por separado para cada uno de los manuales de usuario.

Las piezas comunes de ayuda se pueden utilizar para crear una documentación para las diferentes versiones de la aplicación. Para que los usuarios no perder tiempo en la búsqueda de funciones, que a ellos no se pueden hacer individuales manuales para cada versión. Gran parte de la ayuda será manejado a través de la función Topic Sharing.

El firmware de la herramienta para hacer capturas de pantalla en el Manula no – tiene que descargar imágenes existentes en la biblioteca de imágenes (total para todos los proyectos) y, a continuación, insertar en los lugares adecuados de la documentación. Adición de texto también se realiza en línea en el editor, los desarrolladores de servicio, capaces de idear algo interesante. Junto con el uso del editor visual, se propone trabajar con los códigos de Textile para acelerar el proceso de formateo. Estos códigos dan la posibilidad de dar formato a un texto sin la necesidad de recurrir a los botones del editor. Por ejemplo, si el texto es necesario distinguir, se debe concluir en dos asteriscos (*aquí*), y para crear un encabezado de primer nivel, basta con escribir en el principio de la línea h1-.

StepShot – quitará, pondrá en orden y firmará

  • Desarrollador: StepShot.
  • Sistema operativo: Windows.
  • Distribución: por suscripción ($29 por mes). Hay funciones de juicio la versión de 14 días, que luego se convierte en limitada.
  • Interfaz de rusia: no.

Prácticamente cada guía de usuario contiene necesariamente una instrucción, lo que explica cuáles son los pasos que debo hacer para lograr un resultado específico. Leer estos manuales, en donde cada paso se acompaña de capturas de pantalla y la explicación, es un placer, pero aquí está su creación, a menudo se extiende a través de largas horas. Algunos redactores técnicos primero escriben el texto y, a continuación, hacen todas las capturas de pantalla y ponen en los lugares adecuados, otros prefieren hacer capturas de pantalla de uno en uno, pegar en el manual e inmediatamente agregar una descripción. En cualquier caso, resulta bastante complicado.

StepShot – un excelente programa que ayuda notablemente a acelerar la creación de instrucciones paso a paso. El sistema permite hacer todas las capturas de pantalla, sin apartar la vista de la conservación y el recuadro, los coloca en el orden correcto, ayuda a añadir una descripción y anotación, y luego publicar en uno de los formatos más populares.

El trabajo en StepShot construida en forma de un asistente. Es necesario crear un nuevo proyecto y, a continuación, iniciar el proceso de captura y comenzar a realizar las acciones que se deben documentar. Cada vez que un usuario hace clic con el ratón, el programa creará una captura de pantalla y guardarla. Cuando este en la pantalla se encuentra la barra de StepShot, la cual se puede detener el proceso de captura y cambiar el modo de realizar capturas de pantalla (pantalla completa, ventana activa, asignada un área rectangular).

Esta barra, naturalmente, en las capturas de pantalla no es visible. Dependiendo de la configuración, la captura puede realizarse sólo cuando el clic se realiza cuando se pulsa la tecla CTRL (o de otro cómoda a la tecla) o, por el contrario, en todos los casos, excepto cuando el usuario mantiene pulsada la tecla de acceso rápido. En la configuración del programa también se puede establecer el retardo entre la pulsación y la creación de capturas de pantalla.

Cuando el proceso de creación de la instrucción se ha completado, todas las imágenes se mostrarán en la ventana de StepShot. A la izquierda se encuentra la barra de navegación con miniaturas de las imágenes, a la derecha – una captura de pantalla en el que está trabajando, así como un área para añadir una descripción. Capturas de pantalla ya puestas en el orden en que fueron hechos, sin embargo, si es necesario, se puede cambiar arrastrando con el ratón. Además, cada paso (la captura de pantalla con la descripción) se puede copiar, borrar, agregar antes de él vacía paso, para el que puede, por ejemplo, importar una imagen desde el disco.

Si la instrucción aparente, tiene sentido dividir en secciones, añadiendo los separadores en los lugares correctos. Para cada sección tiene la posibilidad de introducir el nombre. En la base de los capítulos va a generar de forma automática la tabla de contenido que se encuentra al inicio de la guía.

Normalmente, cuando la creación de los manuales se invierte mucho tiempo para seleccionar un área en la que se encuentra el cursor en la captura de pantalla (normalmente, el lugar donde tienes que hacer click). StepShot da la posibilidad de automatizar y es rutinaria de la acción. Elemento de la interfaz por la que se hace clic, se puede resalta automáticamente con un cuadro rojo o amarillo a su alrededor. Además, el programa automáticamente puede suavizar los bordes de las capturas de pantalla.

En proceso de edición recibidos capturas de pantalla — ya en el modo manual: se pueden agregar flechas, rótulos u otros elementos gráficos y resaltar ciertas áreas de la imagen con el color. Y si en una captura de pantalla debe llamar la atención del lector en varias áreas, puede utilizar la herramienta de la secuencia. Esto crea una línea con los números en la final. Basta con colocarlos en los lugares correctos de la imagen y agregar una descripción.

Agregar descripciones también del máximo grado de automatización. Porque al escribir la documentación técnica a menudo se utilizan las mismas frases, el programa provee a las capturas de pantalla de las descripciones como «Click on «Skype» button». Para ello, se apodera de los nombres de los elementos de la interfaz, los reconoce y, a continuación, agrega la firma debajo de la imagen. Funciona esto, sin embargo, sólo en inglés y con pareja otros idiomas europeos, y los redactores de la lengua rusa de la documentación tendrá que añadir todas las descripciones de la mano.

Las funciones de formato de StepShop básicos – se puede cambiar el tamaño de letra para los títulos de capturas de pantalla y descripciones, poner texto en negrita, cursiva o subrayado, controlar la sangría y la de insertar un hipervínculo. No hay que olvidar que antes de la exportación para el proyecto, puede añadir una descripción y el autor.

Después de trabajar en el desarrollo de la guía completa, puede exportar en uno de varios formatos admitidos: un documento de Word, PDF, HTML, DITA o XML. Al este de Word están disponibles varios modelos diferentes.

También hay directo de la publicación en WordPress y en Confluence, y todas las imágenes utilizadas en el proyecto, ofrece la posibilidad de guardar en la misma carpeta. Pero, lamentablemente, sólo se puede controlar la calidad de las imágenes, y aquí es cambiar los nombres, no se puede. Las capturas de pantalla se guardan con los nombres de los tipos de image0001.jpg, image0002.jpg que no siempre es conveniente (sería bueno si hubiera tenido la oportunidad de nomenclatura de imágenes a partir de los encabezados en el proyecto).

A pesar de que StepShot se aplica a la base de honorarios, para trabajar con el programa de forma gratuita, si usted está dispuesto a resignarse con una marca de agua en las imágenes. Además, la versión gratuita te permite crear un máximo de cinco proyectos que se exportan al mes.

iorad – el equivalente de la StepShot, pero en el navegador

  • Desarrollador: iorad inc.
  • Sistema operativo: cualquier.
  • Distribución: por suscripción ($90 al mes). Hay una versión gratuita limitada.
  • Interfaz de rusia: no.

Para empezar con iorad es necesario instalar una extensión para Google Chrome y abrir la página web, los pasos que debe ser documentado. Después de esto, el autor debe hacer clic en el botón de la extensión. En el servicio web iorad aplicar el mismo enfoque que en StepShot (el autor de la instrucción realiza todas las acciones, el servicio de su guarda, divide a los pasos que a continuación, puede editar y publicar en forma de lección). Sin embargo, iorad funciona como una extensión al navegador, y todos los pasos de procesamiento, edición y publicación de instrucciones paso a paso se ejecutan en el servidor. Por un lado, es útil, ya que el servicio está disponible en cualquier plataforma, sin embargo, hay un desafortunado límite – con la ayuda de iorad puede grabar sólo las acciones realizadas en el navegador. Es decir, el servicio sólo es adecuado para la creación de manuales de aplicaciones web y de escritorio de los programas no sirve para nada.

Después de hacer clic iorad dará tres segundos en la preparación, después de lo cual se iniciará la grabación. El servicio reconoce y guarda cualquier acción clic, doble clic, desplazarse por la ventana, el juego del texto y así sucesivamente. Cuando la entrada de la instrucción se completa, sólo tienes que pulsar en el botón de la extensión en la barra de Chrome. El proceso también se puede suspender en el tiempo y, a continuación, reanudar.

Cuando la grabación se ha completado, iorad restaurará todas las acciones del usuario y lo herirá en la instrucción en los pasos. Todos los elementos de la interfaz, que se pusieron en marcha, serán seleccionados (por ejemplo, un botón, de la que desea hacer click). Además, iorad agrega automáticamente un texto simple de instrucciones para cada paso.

Cada lección comienza con la propuesta del «The first step is to open [nombre de la vebs-página]», y termina con la frase «That’s it. You’re done.» A pesar de que las descripciones automáticamente se elaboran sólo en inglés, en el acabado de las instrucciones tienen la oportunidad de verlos en otros idiomas a través de la integración con el traductor de Google. Si no añadir extensos, descripciones, a limitarse frases simples, la traducción funciona medianamente.

Sin embargo, si se toma un poco de tiempo, puede agregar inmediatamente la descripción de la lengua materna. Sin embargo vale la pena recordar que la longitud de la descripción limitada de 250 caracteres. En él se pueden utilizar diferentes opciones de la fuente, así como de los hipervínculos. Además, para cada paso, puede agregar audioinstruktsiyu una duración de hasta un minuto. Puede escribir directamente en la interfaz web de la aplicación o descargar disponibles en el sistema de archivos.

En cuanto a las herramientas para la edición de capturas de pantalla, entonces los creadores de iorad todavía hay mucho en que trabajar. Todo lo que puede hacer el usuario, es la de lubricar la parte de la imagen, cambiar el tamaño y la ubicación de un marco para la selección.

Preparadas las instrucciones pueden ser guardados en forma de archivos Doc de Word, PowerPoint y PDF, y también a la práctica en los sitios o ver en el navegador en todas las plataformas, tanto de escritorio como móviles. Utilizando las últimas dos opciones, se puede apreciar la ventaja principal de iorad – la interactividad. La instrucción recibida a través de un servicio que se ejecuta en un reproductor. El usuario puede seleccionar una de las opciones de trabajar con ella: la visualización o la misma independiente de la repetición de todos los pasos.

En el primer caso, todas las capturas de pantalla y descripciones de ellos se muestran en una sola página, y sólo puede leer lo que hacer. En el segundo caso, se invita al usuario a repetir todos los pasos del autor, para lograr el resultado deseado. Es decir, se lee la descripción de la imagen, realiza la acción, y sólo después de esto, pasa al siguiente paso. Una excelente solución para asegurarse de que el usuario realmente dio cuenta de que necesitaba hacer.

Conclusión

Programas especializados para la creación de manuales pueden notablemente a acelerar la creación de documentación técnica. Sin embargo, el que más claro, detallado y estructurado, el archivo de ayuda, completamente sólo depende de sus compiladores.

Trabajando en la documentación, siempre vale la pena recordar el principio de «Habitabilidad»: el usuario es necesario no dar demasiada información, no demasiado poco, y en la precisión del tiempo necesario para la ejecución de las tareas. Una buena documentación debe funcionar como un navegador: una vez que el usuario ha mostrado en qué lugar se encuentra (¿qué problema chocó), inmediatamente se debe con un archivo de ayuda en encontrar el camino correcto (solución de problemas). Y por supuesto, no hay que olvidarse de los hipervínculos, que hay que asegurar la libre circulación de usuario de manualu. Si en sus manos podrobneyshiy PDF de 100 páginas, en el que no hay ninguna referencia, la calidad de esa documentación, difícilmente se puede apreciar a alguien, además de su compilador.

Sin embargo, las herramientas modernas para la creación de los manuales de referencia tan diversas y multifuncionales, que crear detallada, clara y bien decorada documentación a través de ellos es muy fácil.

Source: 3dnews.ru

Leave comment

Your email address will not be published. Required fields are marked with *.