¿Cómo puedo administrar capturas de pantalla y otros gráficos para el mantenimiento?

Nuestro conjunto de documentación de ~1500 páginas contiene numerosas capturas de pantalla y gráficos relacionados (esquemas, diagramas de flujo, etc.). A veces la interfaz de usuario cambia y tenemos que actualizar todos los gráficos afectados. Los gráficos afectados no están necesariamente todos en un libro; se pueden repartir entre varios. En resumen, podrían estar en cualquier lugar, por lo que confiamos en el conocimiento de los escritores sobre el conjunto de documentos y, a veces, solo buscamos gráficos que ya no sean correctos. El primero es frágil y el segundo es tedioso (y también puede ser frágil).

Dentro de la fuente de documentos XML en sí, puedo (y lo hago) incrustar etiquetas internas que luego puedo buscar. Piense en eso como metadatos para los documentos. Estoy buscando una manera de asociar metadatos con imágenes, para poder encontrar todas las imágenes que muestren tal o cual característica o tal o cual widget o lo que sea. Podría configurar un archivo de índice externo o una base de datos, pero eso significa que los metadatos están lejos de las imágenes y me preocupa que se mantengan actualizados (¿recordará siempre cada escritor actualizar la base de datos cuando crea o edita una imagen y sus metadatos cambian?). ¿Hay algo inteligente que pueda hacer para acercar los metadatos a los datos?

Los formatos de imagen son PNG para capturas de pantalla, GIF para arte lineal. ¿Existe alguna herramienta que nos permita incrustar y consultar metadatos directamente en archivos en esos formatos?

Nuestras herramientas relevantes existentes son: Perforce para el control de código fuente, DocBook XML para el código fuente del documento, Ant para los objetivos de compilación. En el lado de los gráficos, usamos PaintShop Pro y/o SnagIt para tomar/editar capturas de pantalla, y principalmente Visual Thought para el arte lineal (aunque tenemos acceso a InkScape y podemos aprenderlo si eso ayuda). Nuestros escritorios son Windows (XP ahora, 7 a finales de este año).

Editar: las capturas de pantalla también tienen implicaciones de texto; por lo general, no solo tenemos una captura de pantalla, sino una captura de pantalla y un texto que habla sobre las opciones o lo que puede hacer con esa herramienta. Las capturas de pantalla son parte integral de la documentación, y si se debe actualizar una captura de pantalla, también debemos buscar en los lugares donde se usa esa imagen. Encontrar esos puntos en el texto es fácil (puedo buscar la fuente del nombre de archivo de cada imagen cuando la actualizo), pero encontrar las capturas de pantalla que tienen que cambiar en primer lugar (porque la interfaz de usuario cambió) es mucho más difícil . Esta pregunta trata sobre la gestión de ese proceso para que podamos mantener toda la documentación actualizada.

Esta pregunta podría ser más adecuada para Graphic Design SE.
No estoy de acuerdo con @Steven en que esto encaja en Diseño Gráfico. Es un problema de metadatos y cumple con nuestros criterios para preguntas sobre el uso de software.
¿Por qué no preguntar en ambos foros y ver cuáles son las respuestas?
Parece que se trata más de diseño que de implementación (incluso dicen que no se hagan preguntas sobre cómo hacerlo). No soy quisquilloso; Quiero preguntarle dónde es más apropiado, donde sea que esté.
Relacionado con SuperUser (donde puede obtener más expertos que aquí en Writers), ¿Qué software puedo usar para leer metadatos PNG?
No creo que esto tenga nada que ver con Writing o Writers.SE
Las preguntas frecuentes dicen que "el proceso de publicación y edición" está en el tema, pero si no entiendo bien la intención de este sitio, me inclino ante aquellos con más experiencia. (Las preguntas de ficción abruman al resto, por lo que es difícil para mí resolver esto).
Es una buena pregunta, pero estoy de acuerdo con Ralph, está fuera de tema aquí. Sea como fuere, mi recomendación para usted sería usar un escritor de metadatos para agregar metadatos a cada imagen (tal vez usando algo como PhotoMe, pero hay muchas herramientas de edición de metadatos), luego use la búsqueda de Windows 7 (que debería buscar metadatos) o use Google Desktop para encontrar los archivos que necesita. Sin embargo, no estoy seguro de si Windows XP analiza los metadatos. Buena suerte.
Por cierto, acabo de hacer una prueba (ya que yo mismo uso PaintShopPro de vez en cuando). Puedes editar los metadatos de tus imágenes en el mismo PSP (Imagen > Información de la imagen). Agregué la palabra "metadatos" a una imagen ficticia en el campo de descripción. Windows XP también podrá buscar estos datos si especifica el directorio, elige buscar imágenes y fotos solamente y busca "una palabra o frase en un archivo". Busqué "metadatos" y encontré lo que buscaba.
Dado que la escritura técnica está en el tema , y ​​esta es una pregunta sobre el mantenimiento en un proyecto de escritura técnica, no veo ninguna razón por la que esto esté fuera de tema.
Tal vez una de las herramientas recomendadas aquí te ayude: superuser.com/questions/98701/…
Charle más sobre si esto está relacionado con el tema: chat.stackexchange.com/transcript/message/3834965#3834965

Respuestas (4)

Dado que esto se considera sobre el tema, daré mi recomendación como una respuesta adecuada.

En lugar de recomendar otras herramientas, a juzgar por su configuración (Paintshop Pro, Windows XP o Windows 7), el método más sencillo es usar estas herramientas existentes para hacer lo que necesita:

  1. Use Paintshop Pro para agregar metadatos a sus imágenes. Puede hacerlo yendo a Imagen > Información de la imagen. Agregué metadatos al campo "Descripción" de la imagen. De esta manera, puede agregar palabras (tal vez incluso desarrollar su propio sistema de etiquetas) que usará para buscar. También puede agregar otros datos como quién tomó la captura de pantalla, la fecha en que se modificó por última vez, etc. Si planifica los metadatos, puede crear un sistema realmente bueno para organizar sus imágenes.

  2. Una vez hecho esto, puede usar la búsqueda integrada de Windows XP para encontrar el archivo (lo mismo debería funcionar en Windows 7 también). Simplemente especifique el directorio que necesita, elija "Imágenes y fotos" solamente y luego seleccione "para una frase o palabra en un archivo". Escriba la frase/etiqueta que está buscando, haga clic en buscar y debería encontrar la imagen que está buscando.

¡Gracias! Esto funcionó para mí y no requiere obtener aprobación para ninguna herramienta nueva.

Para el libro que estoy escribiendo actualmente, que no está escrito en docbook directamente pero está escrito en un marcado que se traducirá a DocBook para su publicación, utilizo un archivo XML para capturar los metadatos de cada ilustración.

<?xml version="1.0" encoding="UTF-8"?>
<image>
    <source>assemble.svg</source>
    <fo>
        <href>assemble.svg</href>
        <contentwidth>4.25in</contentwidth>
        <align>center</align>
    </fo>
    <epub>
        <href>assemble.png</href>
    </epub>
    <alt>
        <p>A diagram showing multiple pieces being combined in different ways to produce different outputs.</p>
    </alt>
</image>

Debido a que el libro se publicará tanto en papel como en formato electrónico, necesitamos diferentes formatos de archivo para cada gráfico. Aquí está el gráfico de origen assemble.svgy el mismo archivo se usa para imprimir ( fosignifica xsl-fo). Pero para epub, que no es compatible con SVG, usamos assemble.png. El XML también proporciona una altpara el gráfico y también le permite incluir información de tamaño.

Cuando incluyo un gráfico en el libro, la instrucción de inclusión en realidad apunta al archivo XML en lugar de al archivo gráfico directamente. Luego, el código de procesamiento lee el archivo XML y genera marcado DocBook condicional para usar con cada versión de la compilación del libro.

Este enfoque soluciona las dificultades de incluir metadatos en los propios archivos gráficos y le permite un nivel de abstracción que le permitirá usar diferentes formatos de archivo para diferentes medios.

Algo similar debería ser viable para sus compilaciones. Simplemente requerirá algún procesamiento previo de sus archivos fuente o algunas reglas adicionales para procesar gráficos.

La desventaja de apuntar al archivo XML en lugar del gráfico es que el gráfico no se mostrará en un editor XML gráfico. Pero hay una forma de evitar esto. En lugar de apuntar al archivo XML en el origen, apunte a un archivo gráfico como de costumbre, pero reescriba el código de procesamiento para que la instrucción de inclusión elimine la extensión del archivo gráfico y lea un archivo XML del mismo nombre en el mismo directorio.

Oh wow, eso es inteligente!

Solía ​​trabajar en un proyecto en el que escribíamos una interfaz de usuario gráfica para Subversion para un grupo de artistas. Aunque no puedo vincular ese programa en particular. Subversion esencialmente debería poder hacer todo lo que necesita. Artículo de ejemplo: http://www.wensh.net/archive.php/topic/1556.html

Madcap Flare debería ayudar.

¿Podrías decir un poco más? De esa página parece que Madcap Flare es un sistema de publicación completo. Ya tenemos un sistema de publicación y no buscamos reemplazarlo. ¿Hay alguna capacidad que Flare tiene que resolvería nuestro problema sin incurrir en los costos de volver a implementar todo lo que ya tenemos?