Unser Team muss viele Routineaufgaben automatisieren. Können wir ein einzelnes Tool verwenden oder müssen wir mehrere verwenden?

Unser Tech-Comm-Team hat eine Vielzahl von zeitaufwändigen, sich wiederholenden Aufgaben, die wir automatisieren müssen. Wir verwenden hauptsächlich Sphinx , reStructuredText , Adobe Illustrator und Visio.

Spezifische Dinge, die wir automatisieren und entweder über eine GUI oder die Befehlszeile zugänglich machen müssen, sind:

  • Erstellen von reSructuredText-Dateien und den zugehörigen Indexeinträgen im :toctree:mit einer Reihe von Parametern, die der Autor angeben kann und die zum Ausfüllen von Feldern wie :ref:Name, Titel der Seite, Dateiname, Index-Tags und Speicherort der darin enthaltenen Seite verwendet werden die Navigationshierarchie.
  • Verschieben von Abschnitten der Dokumentation an eine neue Position im Inhaltsverzeichnis.
  • Öffnen einer Visio- und/oder Illustrator-Vorlage und entsprechendes Verknüpfen in der .rstDatei mit einer bestimmten Anweisung, z. B. einer Abbildung oder einem Bild mit den richtigen Breiten-/Höhenabmessungen und Beschriftungen.

Wir möchten den Werkzeugaufwand auf ein Minimum beschränken. Es muss eine Lösung sein, die dem gesamten Team beigebracht werden kann, das meist keinen Programmierhintergrund hat, aber bereit ist, es zu lernen.

Wäre ein Makroprogramm wie Automator (wir verwenden Macs) am besten geeignet? Müssen wir eine Programmiersprache in Betracht ziehen? Auch hier möchten wir eine einzelne Technologie/ein einzelnes Werkzeug auswählen, nicht mehrere.

Dies scheint keine Frage zum Thema Technische Kommunikation im Kontext dieser Website zu sein. Dass Sie gerade mit einer technischen Redaktion beschäftigt sind, ist dem eigentlichen Thema dieses Beitrags nur zufällig zuzuordnen. Wir müssen uns ein wenig davor hüten, dass dies zu einer allgemeinen Computersite wird.
Es gibt viele Tastatur-Makro-Tools, mit denen Sie weniger intelligente, aber dennoch mühsame Automatisierung durchführen können. Ich mag AutoHotKeys.
Ich werde versuchen, dem einen Techcomm-Spin zu verleihen :) Ich habe ein VBA-Skript erstellt, das einige grundlegende Bearbeitungsaufgaben an Word-Dokumenten ausführt (ich nenne es das "Editor's Eye"). Es durchläuft ein Dokument und markiert oder ändert eine Liste bekannter Probleme (Großschreibung, Wortwahl, Rechtschreibung usw.). Es hat mir (und meinen nicht englischsprachigen Ingenieurautoren) viel Zeit gespart. Wenn du den Code sehen möchtest, PN an mich.
Ich denke, das Thema ist absolut kommunikationstechnisch. Produktivität und Effektivität sind für jeden Tech-Redakteur wichtig, und meiner Erfahrung nach hat das Schreiben von Skripten zur Automatisierung von Tech-Comm-Aufgaben unserem Team enorm geholfen, Zeit bei manuellen Aufgaben zu sparen und sich auf das eigentliche Schreiben zu konzentrieren. Ich stimme dafür, die Frage erneut zu stellen. Was die Antwort betrifft, unser Team verwendet Python ausgiebig, um die Aufgaben wie die in der Frage erwähnten zu automatisieren.
@Amruta2799: Ich stimme zu, dass es ein wichtiger Vorteil für Tech-Comm-Teams ist, die oft keine Programmierkenntnisse haben. Ich werde versuchen, eine domänenspezifischere Frage zu stellen.
Ich habe die Frage entsprechend dem gegebenen Feedback umformuliert.
Ich denke, dass dies wiedereröffnet werden sollte, da es sich bei den Bearbeitungen um Tools handelt, die häufig in der technischen Redaktion verwendet werden.

Antworten (2)

Automatisieren Sie das langweilige Zeug mit Python von Al Sweigart. Dies ist zweifellos die beste einzelne Ressource, um zu lernen, wie Sie genau das tun, wonach Sie fragen. Es ist ein Buch über das Programmieren für Leute, die keine Programmierer sind, und es konzentriert sich auf die Automatisierung der sich wiederholenden Aufgaben, denen Büromitarbeiter während ihres Arbeitstages begegnen. Sie können es kostenlos online lesen oder ein Exemplar bei Amazon oder No Starch Press erwerben (Links zum Kauf des Buches finden Sie auf der Website).

Fantastische Ressource! Ich habe dies eingesetzt und es ist genau das Werkzeug, das wir brauchen. Extrem flexibel und dennoch für unser Team zugänglich.

Um eine Datenbearbeitungsaufgabe zu automatisieren, benötigen Sie zwei Dinge:

  • Zugriff auf die Metadaten oder Muster in den Quelldaten, auf die Sie reagieren möchten.
  • Die Möglichkeit, die Metadaten oder Daten der Quelle so zu ändern, dass Sie die Datei nicht beschädigen oder unlesbar machen.

Der Grund dafür, dass so viele Systeme, die ein hohes Maß an Automatisierung zulassen möchten, XML als Dateiformat verwenden, liegt darin, dass das XML-Format darauf ausgelegt ist, diese beiden Operationen zu erleichtern. (Die Tatsache, dass ein XML beispielsweise keine Zeiger oder Strukturen mit fester Größe verwendet, bedeutet, dass Sie seinen Inhalt aktualisieren können, ohne andere Daten in der Datei aktualisieren zu müssen.)

Es gibt auch viele gute, gut getestete Tools zur Manipulation von XML, sowohl für den Zugriff auf Metadaten und Muster in der Datei als auch für die Aktualisierung der Dateien, ohne sie zu beschädigen.

Da Sie ein System mit mehreren Dateiformaten haben, die Sie automatisieren möchten, benötigen Sie entweder ein Tool, das auf alle diese Dateiformate zugreifen und diese bearbeiten kann, oder Sie benötigen mehrere Tools.

Die meisten Programmiersprachen erlauben Ihnen natürlich, auf nahezu jede Datei zuzugreifen oder sie zu aktualisieren, aber abgesehen von Bibliotheken zur Adressierung bestimmter Formate überlassen sie es Ihnen auch ganz und gar, zu entschlüsseln, wie diese Dateiformate gelesen und geschrieben werden können sehr nicht trivial sein. Python ist eine gute Wahl, wenn Sie diesen Weg gehen, aber bedenken Sie, dass es eine Menge Arbeit sein wird, Ihre Automatisierung zuverlässig zum Laufen zu bringen, wenn Sie keine Bibliotheken zum Manipulieren aller von Ihnen verwendeten Dateiformate finden können, und dass ein Update in jedem möglich ist der beteiligten Dateiformate könnte es brechen.

Die Antwort lautet also, dass Sie wahrscheinlich verschiedene Tools benötigen. Aber dann stößt man natürlich auf das Problem, dass man den Betrieb und den Informationsaustausch zwischen diesen Tools integrieren muss.

All dies sagt aus, dass wenn Sie ein hohes Maß an Automatisierung wünschen, Ihr bester Weg möglicherweise nicht darin besteht, nach Tools zu suchen, um Aufgaben für alle Formate zu automatisieren, die Sie jetzt verwenden, sondern nach einem Format oder Formaten zu suchen, die bereits großartig sind Automatisierungsfunktionen oder die so konzipiert wurden, dass sie leicht manipulierbar sind. Und diese Suche wird Sie wahrscheinlich (wenn auch nicht sicher) zu XML führen.

Unser Team muss viele Routineaufgaben automatisieren. Können wir ein einzelnes Tool verwenden oder müssen wir mehrere verwenden?
AntwortenHierDatenschutz-Bestimmungen1y, 0v