Colay / Anleitungen

Aktualisieren Sie eine Wissensdatenbank stapelweise, ohne die Kontrolle über die Änderungen zu verlieren

Wenn eine Produktänderung viele Artikel und Supportskripte betrifft, besteht die Hauptaufgabe darin, das Update zu koordinieren. Colay kann dabei helfen, Umschreibungsansätze zu vergleichen und ausgewählte Textblöcke zu entwerfen. Ein Änderungsregister, ein gemeinsames Informationsblatt und eine Überprüfungswarteschlange machen diese Entwürfe stapelweise nutzbar. Hierbei handelt es sich um einen verwalteten Redaktionsworkflow und nicht um eine automatische Verbindung, die Ihre Wissensdatenbank im Hintergrund aktualisiert.

Inventarisieren Sie den betroffenen Inhalt, bevor Sie Text generieren

Beginnen Sie bei der Produktänderung und durchsuchen Sie bestehende Inhalte nach alten Begriffen, Regeln oder Abläufen. Erfassen Sie Artikel-IDs, Supportmakros, Onboarding-Nachrichten und interne Anweisungen, die davon betroffen sein könnten. Ähnliche Titel bedeuten nicht identischen Inhalt, und ein Modell kennt nicht automatisch jede Stelle mit dem alten Wortlaut.

Erstellen Sie ein genehmigtes Änderungsblatt mit dem alten Verhalten, dem neuen Verhalten, dem Datum des Inkrafttretens, den Ausnahmen und der genauen Terminologie. Weisen Sie für ungeklärte Sachverhalte einen Eigentümer zu. Trennen Sie sachliche Aktualisierungen von optionalen Stilbereinigungen, damit ein schönerer Satz keine Richtlinienänderung verbirgt. Für Verfahrenstexte bevorzugen die Leitlinien von Google klare Handlungsschritte und expliziten Kontext; Wenden Sie den gleichen Standard für die gesamte Charge an.

Verwenden Sie ein Register, das jedes Element bis zur Veröffentlichung verfolgt

Ein fiktiver Dienst verlegt seine Exportschaltfläche. Der freigegebene neue Pfad lautet Reports → Export; Berechtigungen und Ausgabeformate bleiben gleich. Ihre Bestandsliste enthält eine Anleitung, eine Onboarding-Checkliste und eine Supportantwort. Diese Beispieldaten beschreiben nicht Colays Oberfläche.

Die Elemente müssen unterschiedlich bearbeitet werden: Für eine vollständige Anleitung ist möglicherweise ein neuer Screenshot erforderlich, für eine Checkliste muss eine Beschriftung geändert werden und für das Support-Skript ist möglicherweise nur ein korrigierter Pfad erforderlich. Das Generieren von acht vollständigen Überarbeitungen jedes Elements würde Überprüfungsarbeit erfordern, ohne das Update unbedingt zu verbessern.

Beispiel-Batch-Register für eine fiktive Schnittstellenänderung
InhaltErforderliche ÄnderungPrüfnachweisStatus
KB-12 ExportleitfadenPfad und Screenshot aktualisierenExport mit der angegebenen Rolle durchlaufenEntwurf wartet auf Überprüfung
ON-4 Onboarding-ChecklisteAlte Position des Bedienelements ersetzenVerlinkte Anleitung und sichtbare Bezeichnung prüfenBereit zur Prüfung durch die verantwortliche Person
SUP-7 gespeicherte AntwortKorrigieren Sie eine AnweisungTesten Sie die Antwort anhand einer BeispielfrageNicht gestartet

Kalibrieren Sie anhand einer kleinen repräsentativen Probe

Acht Arten des Umschreibens können während der Kalibrierung nützlich sein: prägnante Vorgehensweise, Erklärung für Anfänger, Fehlerbehebung, FAQ, Support-Antwort, interne Checkliste, auf Barrierefreiheit ausgerichtete Klartextsprache und kurze Zusammenfassung. Wählen Sie die Formate aus, die das Inventar tatsächlich benötigt. Die nützliche Ausgabe ist eine konsistente Bearbeitungsregel, nicht acht konkurrierende Versionen jeder Seite.

  1. Wählen Sie einen einfachen Artikel, einen Artikel mit Ausnahmen und ein Support-Skript. Entwerfen Sie diese, bevor Sie den Rest des Inventars bearbeiten.
  2. Geben Sie verfügbaren Colay-Agenten das gleiche Änderungsblatt und fragen Sie nach alternativen Bearbeitungsansätzen. Vergleichen Sie, ob alle unveränderten Regeln erhalten bleiben.
  3. Genehmigen Sie ein Bearbeitungsmuster und eine Terminologieliste. Bewahren Sie Beispiele für akzeptierte und abgelehnte Änderungen neben dem Batch-Brief auf.
  4. Durcharbeiten Sie verwaltbare Inhaltsgruppen manuell und behalten Sie dabei jede Elementkennung und ihre Quellversion bei. Stoppen Sie den Stapel, wenn ein neuer Widerspruch auftritt.

Ein Prompt für eine nachvollziehbare Einzeländerung

Stellen Sie nur Material zur Verfügung, das für diese Verwendung zugelassen ist, und lassen Sie unnötige Kundendaten weg. Behalten Sie das maßgebliche Register in Ihrem vorhandenen Dokumenten- oder Inhaltssystem. Die von Colay generierte Antwort selbst aktualisiert nicht den Veröffentlichungsstatus des Artikels.

Inhaltselement [ID und Quellversion] mithilfe dieses genehmigten Änderungsblatts aktualisieren: [altes Verhalten, neues Verhalten, Datum des Inkrafttretens, Ausnahmen]. Vorhandener Text: [Text]. Genehmigte Terminologie und Bearbeitungsmuster: [Regeln]. Senden Sie den überarbeiteten Text, eine Liste der geänderten Passagen mit Begründung, von Ihnen beibehaltene unveränderte Regeln und Fragen, die die Veröffentlichung blockieren, zurück. Ändern Sie nur die betroffenen Inhalte. Behalten Sie Links und Kennungen bei, es sei denn, das Briefing ändert sie ausdrücklich. Erfinden Sie keine neuen UI-Beschriftungen, Berechtigungen, Daten oder Produktverhalten. Wenn dieses Element mit dem Änderungsblatt in Konflikt steht, kennzeichnen Sie den Konflikt, anstatt ihn durch Rätselraten zu lösen.

Veröffentlichen Sie geprüfte Gruppen und bewahren Sie die alte Fassung auf

Überprüfen Sie vor der Veröffentlichung jede geänderte Anweisung, Ausnahme und jeden Link anhand der genehmigten Quelle und des tatsächlichen Produkts. Überprüfen Sie das gesamte Dokument rund um die Änderungen: Ein korrigierter Absatz kann immer noch im Widerspruch zu einer unveränderten Einleitung stehen. Erfassen Sie den Genehmiger und behalten Sie die vorherige Inhaltsversion bei.

Veröffentlichen Sie über Ihre vorhandenen Tools und überprüfen Sie dann den Live-Artikel und alle gespeicherten Antworten, die darauf verweisen. Markieren Sie einen Artikel erst nach dieser Prüfung als abgeschlossen. Verfolgen Sie die verstrichene Redaktionszeit und nach der Veröffentlichung gefundene Korrekturen, wenn Sie den Prozess bewerten möchten. Ein Batch-Workflow kann wiederholte Briefings reduzieren, das Ergebnis hängt jedoch vom Inhalt und dem Überprüfungsaufwand ab; Es verspricht nicht, automatisch eine Woche zu sparen.

Antworten auf Ihre Fragen

Kann ich die gesamte Wissensdatenbank hochladen und automatisch aktualisieren?

Dieser Artikel beschreibt die manuelle, kontrollierte Erstellung von Textentwürfen mit Colay. Er behauptet weder einen automatischen Wissensdatenbank-Connector noch eine Stapelveröffentlichung oder Hintergrundsynchronisierung.

Wie groß sollte eine Charge sein?

Verwenden Sie eine Gruppe, die klein genug ist, damit der Prüfer jedes betroffene Element mit dem Änderungsblatt vergleichen kann. Reduzieren Sie die Größe, wenn sich die Regeln oder Inhaltsformate unterscheiden.

Was passiert, wenn zwei Quellartikel einander widersprechen?

Stoppen Sie diese Elemente und fragen Sie den Inhalts- oder Produkteigentümer, welche Regel maßgeblich ist. Behalten Sie den Konflikt im Register, damit eine flüssige Neuformulierung ihn nicht verbirgt.

Quellen und Methodik

  1. Google: writing procedures

    Primäre Schreibanleitung für Handlungsschritte und Kontext; Das Chargenregister und der Freigabeworkflow sind originale redaktionelle Empfehlungen.

Senden Sie Ihre nächste Frage an Colay

Wählen Sie ein Modell, verwenden Sie Auto oder bringen Sie mehrere Perspektiven mit Consensus zusammen.

Mein Update planen