Wie kann ich Screenshots und andere Grafiken für die Wartung verwalten?

Unser ca. 1500-seitiges Dokumentationsset enthält zahlreiche Screenshots und zugehörige Grafiken (Schaltpläne, Flussdiagramme usw.). Manchmal ändert sich die Benutzeroberfläche und wir müssen alle betroffenen Grafiken aktualisieren. Die betroffenen Grafiken befinden sich nicht unbedingt alle in einem Buch; sie können auf mehrere verteilt werden. Kurz gesagt, sie könnten überall sein, also verlassen wir uns auf das Wissen der Autoren über den Dokumentationssatz und blättern manchmal einfach durch das Ganze, um nach Grafiken zu suchen, die nicht mehr korrekt sind. Das erste ist zerbrechlich und das zweite ist mühsam (und kann auch zerbrechlich sein).

Innerhalb der XML-Dokumentquelle selbst kann ich (und tue) interne Tags einbetten, nach denen ich später suchen kann. Stellen Sie sich das als Metadaten für die Dokumente vor. Ich suche nach einer Möglichkeit, Metadaten mit Bildern zu verknüpfen, damit ich alle Bilder finden kann, die diese und jene Funktion oder dieses und jenes Widget oder was auch immer zeigen. Ich könnte eine externe Indexdatei oder Datenbank einrichten, aber das bedeutet, dass die Metadaten weit von den Bildern entfernt sind, und ich mache mir Sorgen, dass sie auf dem Laufenden bleiben (wird jeder Autor immer daran denken, die Datenbank zu aktualisieren, wenn er ein Bild erstellt oder bearbeitet und seine Metadaten ändert?). Kann ich etwas schlaues tun, um die Metadaten näher an die Daten zu bringen?

Bildformate sind PNG für Screenshots, GIF für Strichzeichnungen. Gibt es ein Tool, mit dem wir Metadaten direkt in Dateien in diesen Formaten einbetten und abfragen können?

Unsere vorhandenen relevanten Tools sind: Perforce für die Quellcodeverwaltung, DocBook XML für die Dokumentquelle, Ant für Build-Ziele. Auf der Grafikseite verwenden wir PaintShop Pro und/oder SnagIt zum Aufnehmen/Bearbeiten von Screenshots und hauptsächlich Visual Thought für Strichzeichnungen (obwohl wir Zugriff auf InkScape haben und es lernen können, wenn das helfen würde). Unsere Desktops sind Windows (XP jetzt, 7 später in diesem Jahr).

Bearbeiten: Die Screenshots haben auch Textimplikationen – wir haben normalerweise nicht nur einen Screenshot, sondern einen Screenshot und Text, der über die Optionen spricht oder was Sie mit diesem Tool tun können. Die Screenshots sind integraler Bestandteil der Dokumentation, und wenn ein Screenshot aktualisiert werden muss, müssen wir uns auch die Stellen ansehen, an denen dieses Bild verwendet wird. Diese Punkte im Text zu finden ist einfach (ich kann einfach die Quelle für den Dateinamen jedes Bildes suchen, wenn ich es aktualisiere), aber die Screenshots zu finden, die sich überhaupt ändern müssen (weil sich die Benutzeroberfläche geändert hat), ist viel schwieriger . Bei dieser Frage geht es um die Verwaltung dieses Prozesses, damit wir die gesamte Dokumentation auf dem neuesten Stand halten können.

Diese Frage ist vielleicht besser für die Graphic Design SE geeignet.
Ich werde @Steven nicht zustimmen, dass dies zu Graphic Design passt. Es handelt sich um ein Metadatenproblem, das unsere Kriterien für Fragen zur Softwarenutzung erfüllt.
Warum nicht in beiden Foren fragen und sehen, was die Antworten sind?
Das sieht so aus, als ginge es mehr um Design als um Implementierung (man sagt sogar, man solle keine How-to-Fragen stellen). Ich bin nicht pingelig; Ich möchte es fragen, wo es angemessener ist, wo immer das ist.
Bezogen auf SuperUser (wo Sie möglicherweise mehr Experten finden als hier bei Writers): Welche Software kann ich zum Lesen von PNG-Metadaten verwenden?
Ich glaube nicht, dass das irgendetwas mit Writing oder Writers.SE zu tun hat
Die FAQ sagt, dass "der Veröffentlichungs- und Bearbeitungsprozess" zum Thema gehört, aber wenn ich die Absicht dieser Seite falsch verstehe, verneige ich mich vor denen mit mehr Erfahrung. (Die Fiktionsfragen überwältigen den Rest, daher fällt es mir schwer, das herauszufinden.)
Es ist eine gute Frage, aber ich stimme Ralph zu, es ist hier kein Thema. Wie dem auch sei, meine Empfehlung an Sie wäre, einen MetaData Writer zu verwenden, um Metadaten zu jedem Bild hinzuzufügen (vielleicht mit etwas wie PhotoMe, aber es gibt viele Metadaten-Editor-Tools da draußen), und dann die Windows 7-Suche zu verwenden (was sollte Metadaten durchsuchen) oder verwenden Sie Google Desktop, um die benötigten Dateien zu finden. Ich bin mir nicht sicher, ob Windows XP die Metadaten ansieht. Viel Glück.
Übrigens, habe gerade einen Test gemacht (da ich PaintShopPro selbst ab und zu benutze). Sie können die Metadaten für Ihre Bilder in PSP selbst bearbeiten (Bild > Bildinformationen). Ich habe das Wort "Metadaten" zu einem Dummy-Bild im Beschreibungsfeld hinzugefügt. Windows XP kann auch nach diesen Daten suchen, wenn Sie das Verzeichnis angeben, nur Bilder und Fotos durchsuchen und „nach einem Wort oder Satz in einer Datei“ suchen. Ich habe nach "Metadaten" gesucht und gefunden, wonach ich gesucht habe.
Da technisches Schreiben zum Thema gehört und dies eine Frage zur Wartung in einem Projekt zum technischen Schreiben ist, sehe ich keinen Grund, warum dies nicht zum Thema gehört.
Vielleicht hilft Ihnen eines der hier empfohlenen Tools weiter: superuser.com/questions/98701/…
Weiterer Chat darüber, ob dies zum Thema gehört: chat.stackexchange.com/transcript/message/3834965#3834965

Antworten (4)

Da dies als Thema gilt, gebe ich meine Empfehlung als richtige Antwort.

Anstatt andere Tools zu empfehlen, nach Ihrem Setup zu urteilen (Paintshop Pro, Windows XP oder Windows 7), ist es am einfachsten, diese vorhandenen Tools zu verwenden, um das zu tun, was Sie brauchen:

  1. Verwenden Sie Paintshop Pro, um Ihren Bildern Metadaten hinzuzufügen. Sie können dies tun, indem Sie zu Bild > Bildinformationen gehen. Ich habe Metadaten zum Feld "Beschreibung" für das Bild hinzugefügt. Auf diese Weise können Sie Wörter hinzufügen (vielleicht sogar Ihr eigenes Tag-System entwickeln), nach denen Sie suchen werden. Sie können auch andere Daten hinzufügen, z. B. wer den Screenshot gemacht hat, das Datum der letzten Änderung usw. Wenn Sie die Metadaten planen, können Sie ein wirklich gutes System zum Organisieren Ihrer Bilder aufbauen.

  2. Sobald dies erledigt ist, können Sie die in Windows XP integrierte Suche verwenden, um die Datei zu finden (dasselbe sollte auch unter Windows 7 funktionieren). Geben Sie einfach das gewünschte Verzeichnis an, wählen Sie nur „Bilder und Fotos“ und dann „für einen Satz oder ein Wort in einer Datei“. Geben Sie den gesuchten Ausdruck/Tag ein, klicken Sie auf Suchen und es sollte das gesuchte Bild finden.

Vielen Dank! Dies hat bei mir funktioniert und erfordert keine Genehmigung für neue Tools.

Für das Buch, das ich gerade schreibe, das nicht direkt in DocBook geschrieben ist, sondern in einem Markup, das zur Veröffentlichung in DocBook übersetzt wird, verwende ich eine XML-Datei, um Metadaten für jede Illustration zu erfassen.

<?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>

Da das Buch sowohl auf Papier als auch als E-Book veröffentlicht wird, benötigen wir für jede Grafik unterschiedliche Dateiformate. Hier ist die Quellgrafik assemble.svgund die gleiche Datei wird für den Druck verwendet ( fobedeutet xsl-fo). Aber für epub, das SVG nicht unterstützt, verwenden wir assemble.png. Das XML stellt auch eine altfür die Grafik bereit und ermöglicht es Ihnen, auch Größeninformationen einzufügen.

Wenn ich eine Grafik in das Buch einfüge, verweist die Include-Anweisung tatsächlich auf die XML-Datei und nicht direkt auf die Grafikdatei. Der Verarbeitungscode liest dann die XML-Datei und generiert ein bedingtes DocBook-Markup zur Verwendung mit jeder Version des Buchaufbaus.

Dieser Ansatz umgeht alle Schwierigkeiten beim Einfügen von Metadaten in die Grafikdateien selbst und ermöglicht Ihnen eine Abstraktionsebene, die es Ihnen ermöglicht, unterschiedliche Dateiformate für unterschiedliche Medien zu verwenden.

Etwas Ähnliches sollte für Ihre Builds praktikabel sein. Es erfordert einfach entweder eine Vorverarbeitung Ihrer Quelldateien oder einige zusätzliche Regeln für die Verarbeitung von Grafiken.

Der Nachteil des Zeigens auf die XML-Datei statt auf die Grafik besteht darin, dass die Grafik in einem grafischen XML-Editor nicht angezeigt wird. Aber es gibt einen Ausweg. Anstatt auf die XML-Datei in der Quelle zu zeigen, zeigen Sie wie gewohnt auf eine Grafikdatei, aber schreiben Sie den Verarbeitungscode für die include-Anweisung neu, um die Grafikdateierweiterung zu entfernen und eine XML-Datei mit demselben Namen im selben Verzeichnis zu lesen.

Oh wow, das ist clever!

Ich habe früher an einem Projekt gearbeitet, bei dem wir für eine Gruppe von Künstlern eine grafische Benutzeroberfläche für Subversion geschrieben haben. Obwohl ich dieses bestimmte Programm nicht verlinken kann. Subversion sollte im Wesentlichen alles können, was Sie brauchen. Beispielartikel: http://www.wensh.net/archive.php/topic/1556.html

Madcap Flare sollte helfen.

Kannst du ein bisschen mehr sagen? Aus dieser Seite geht hervor, dass Madcap Flare ein ganzes Veröffentlichungssystem ist. Wir haben bereits ein Publishing-System und wollen es nicht ersetzen. Gibt es eine Fähigkeit, die Flare hat, die unser Problem lösen würde, ohne die Kosten für die Neuimplementierung von allem, was wir bereits haben, zu tragen?
Wie kann ich Screenshots und andere Grafiken für die Wartung verwalten?
AntwortenHierDatenschutz-Bestimmungen1y, 0v