Ein weiteres Json-Dokumentationswerkzeug

Es gibt viele JSON-Strukturdokumentationstools. Ich habe ein weiteres für meine Büroarbeit erstellt .//jsondoc.online

Für mich kann ich sie klassifizieren in:

1. Code dekorative Werkzeuge

Tools, bei denen eine Anmerkung in den Code eingefügt werden muss, und Tools, die eine Dokumentation erstellen, z

2. Deklarative Werkzeuge

Tools, die Text in ein bestimmtes Schema einfügen müssen, analysieren ihn dann und generieren eine Dokumentationsansicht. Zum Beispiel: Json-Schema-Spezifikation

Warum ein anderes Tool erstellen?

Bestehende Tools erfordern ein starkes / klares Verständnis dessen, was Json darstellt

ODER

Es wird davon ausgegangen, dass alle Teammitglieder das Schema verstehen, um es zu definieren / bearbeiten.

Aber inPraxis fand ich Leute Anfrage Antwort in Google-doc teilen Genehmigung zu erhalten.

Google-Doc ist in Ordnung, aber wenn ich eine vorgeschlagene Antwort meines Dienstes im verschachtelten Json-Format in Google-Doc teile, haben andere Teams Schwierigkeiten, sie zu verstehen, damit zu spielen und ein intuitives Denkmodell daraus zu machen.

Daher wurde ein Tool erstellt, mit dem man:

1. Fügen Sie eine JSON-Struktur hinzu und teilen Sie sie mit einem Link.

2. Andere Teams können mit der Json-Baumstruktur spielen.

3. Ein Dokumentationsfenster, in dem Dokumentation angezeigt / hinzugefügt werden kann.

Quellcode: //github.com/bhuvangu/jsondoc.online

Motivation: Persönliches Problem bei der Arbeit