Dokumentationsvorlagen und Checkliste zum Veröffentlichen

Fragen
1

Hallo,
Wir entwickeln derzeit eine benutzerdefinierte Integration (n8n-Knoten, Produktanmeldedaten und Workflows) und möchten diese auf dem n8n Marketplace veröffentlichen.

Referenzen, die wir zur Veröffentlichung gefunden haben, sind

Könntet ihr uns bitte bei Folgendem anleiten?

  • Gibt es Vorlagen zum Erstellen der README und Benutzerdokumentation/Anleitung?
  • Welche Schritte sind erforderlich für die Dokumentationsveröffentlichung (Wir haben ein n8n-docs-Repository gefunden, müssen wir die Dokumentation hier einreichen)?
  • Gibt es offizielle Dokumentation oder eine Checkliste, die wir vor der Einreichung des Knotens befolgen sollten?
  • Bitte teilt auch das entsprechende Verfahren für Workflows mit.

Wenn ihr die relevanten Richtlinien oder Ressourcen teilen könntet, wäre das wirklich hilfreich.
Danke im Voraus!

2

Hey @Abhi_Shah, während du auf eine Antwort wartest, hier sind einige Dinge, die dir helfen könnten:

Empfohlene Ressourcen

Automatisch zu deiner Frage passend.

Dokumentation:

Forum:

@Anshul_Namdev - du hast bei ähnlichen Problemen schon geholfen, kannst du dir das mal anschauen?

Automatisch vorgeschlagen durch n8n’s Community-Bot. Das ist ein Pilotprojekt - bitte teile dein Feedback hier mit.

3

@Abhi_Shah Hallo!
Für Templates ist das die beste Ressource, die ich habe - hier

Verwenden Sie diesen Link, um deinen Node einzureichen und verifizieren zu lassen - hier

Für Workflows auf die Templates-Seite verwende diesen Link - hier
(gleicher Link für beide)

In deinem Workflow kannst du Sticky Notes für die Dokumentation verwenden, aber auch im Creator Hub kannst du eine Beschreibung hinzufügen.

Die folgende Dokumentation erklärt den Prozess, und in der Creator Hub Benutzeroberfläche findest du weitere Anweisungen!
Workflow-Dokumentation

Node-Dokumentation

Du kannst auch hier im Forum beitragen, um deine Arbeit zu zeigen, oder auf GitHub!

4

Hi @Abhi_Shah
Die Dokumentation für Community-Knoten gehört nicht ins n8n-docs-Repository. Zur Verifizierung ist die Dokumentationsanforderung eine README in dem npm-Paket oder in einem zugehörigen öffentlichen Repository, sodass diese README dein Benutzerhandbuch ist. Das n8n-docs-Repo enthält Seitenvorlagen, die du als Struktur dafür verwenden kannst. app-nodes.md, credentials.md und common-issues.md befinden sich im Ordner document-templates/:

Die Checkliste, die n8n vor der Verifizierung überprüft: Grundgerüst aus der n8n-node CLI, Einhaltung der technischen Richtlinien ohne Runtime-Abhängigkeiten, Befolgung der UX-Richtlinien, Bereitstellung der README und Veröffentlichung in npm über einen GitHub Actions-Workflow mit Provenance-Statement. Das letzte ist seit dem 1. Mai 2026 für die Creator Portal-Verifizierung erforderlich. Pakete, die von einem lokalen Computer veröffentlicht werden, werden nicht akzeptiert.

5

Hallo @achamm, @Anshul_Namdev,

Danke für eure schnellen Antworten. Es wurden schon einige Dinge geklärt.

Wir entwickeln einen Satz von Nodes für ein Produkt, zusammen mit benutzerdefinierten Anmeldedaten des Produkts und einigen vordefinierten Workflows.

Bezüglich des npm-Pakets sind wir uns jetzt über die Veröffentlichungsanforderungen im Klaren:

  • README im npm-Paket enthalten, das jeden Node im Format app-nodes.md abdeckt
  • Veröffentlichung des npm-Pakets über GitHub Actions mit einer Provenance-Erklärung
  • Überprüfung der Nodes und Workflows durch Creator-Anmeldung

Beim Durchsehen des n8n-Dokumentations-Repositorys hatten wir jedoch eine Verwirrung, die wir gerne klären möchten. Entschuldigung, wenn sich das wie eine Wiederholung meiner vorherigen Frage anfühlt.

Da unsere Integration dedizierte Anmeldedaten hat, müssen wir auch eine credentials.md zum n8n-Dokumentations-Repository hinzufügen und dort einen separaten PR einreichen?

Danke nochmal für eure Hilfe!

6

@Abhi_Shah Nein! Das ist für integrierte Nodes, wie solche, die direkt in n8n sind. Nach dem, was ich in der Dokumentation gesehen habe, brauchst du das nicht!

Deine gesamte Node-Dokumentation gehört einfach in die README deines Pakets, das ist alles!