Wissensmaler

Verwandeln Sie die Entwicklerdokumentation in präzise Videos

Laden Sie API-Dokumentation, ChangeLogs, Integration Notizen, Architekturdiagramme und andere Entwickler-Dokumentation herunter, um Videos zu generieren, die Anfrage-Paths, Systemverhalten, Versionänderungen und Überprüfungspunkte zeigen.

Verwenden Sie eine visuelle Sequenz, um einen Systempfad zu erläutern

Für wen es ist

  • Entwicklerbeziehungsteams

    Sie benötigen eine Erklärung, die neuen Entwicklern eine Orientierung gibt, bevor sie sich durch die gesamte Dokumentation navigieren.

    • DevRel-Teams
    • Befürworter der Entwickler
    Typische Dokumente:API DokumenteArchitekturdiagramme
  • Produkt- und Engineering-Teams

    Sie möchten, dass eine Release- oder Integrationsänderung einfacher zwischen Personen kommuniziert werden kann, die verschiedene Teile des Systems besitzen.

    • Produktmanager
    • Ingenieurteams
    Typische Dokumente:ÄnderungsprotokolleIntegrationshinweise

Bereiten Sie Ihre Dokumente vor

Beginnen Sie mit der Quelle, der Sie bereits vertrauen

Verwandeln Sie Entwicklerdokumentation wie API-Dokumente, Architekturdiagramme, Änderungsprotokolle und Integrationsnotizen in Videos, die Menschen verfolgen und erneut ansehen können.

  • Entwicklerdokumentation
  • API Dokumentation
  • Architekturdiagramme
  • Änderungsprotokolle
  • Integrationshinweise

Bevor Sie beginnen

  • Verwenden Sie die aktuelle, vollständige Quellversion
  • Markieren Sie die Abschnitte, Schritte, Diagramme oder Abbildungen, die Aufmerksamkeit verdienen
  • Identifizieren Sie die Begriffe, Nummern, Warnungen oder Formulierungen, die beibehalten werden müssen

Ein fokussierter Weg

Erklären Sie den Pfad, nicht nur die Endpunktnamen

  1. 1

    Benennen Sie die Frage des Betrachters

    Geben Sie das Ziel des Entwicklers an, die Systembeziehung, die er verstehen muss, und die aktuelle Version oder Grenze, die wichtig ist.

  2. 2

    Bringen Sie die Quelle mit, die die Details enthält

    Fügen Sie die aktuelle Quelle hinzu und benennen Sie die Abschnitte, Begriffe, Abbildungen oder Schritte, die in der Erklärung erhalten bleiben müssen.

  3. 3

    Verfeinern Sie die Erklärung für den Verwendungskontext

    Lassen Sie den API oder Produktbesitzer vor der Freigabe Terminologie, Beispielverhalten, Versionsverweise und sicherheitsrelevante Grenzen überprüfen.

Nützlicher nächster Schritt

Verwenden Sie eine Ressource oder einen Fall, der dieser Aufgabe entspricht

Verwenden Sie ein quellgestütztes Skript, um einen technischen Pfad sichtbar zu machen

FAQ

Erstellen Sie Ihr erstes Erklärvideo