Showdoc Online-Tool zum Teilen von Dokumenten v3.2.6

ShowDoc ist ein Online-Tool zur API-Dokumentation und technischen Dokumentation, das sich sehr gut für IT-Teams eignet. Über showdoc können Sie ganz einfach die Markdown-Syntax verwenden, um schöne API-Dokumente, Datenwörterbuchdokumente, technische Dokumente, Online-Excel-Dokumente usw. zu schreiben. Wenn Sie Markdown-Dokumente nicht bearbeiten möchten, können Sie auch die Automatisierungsfunktionen von Showdoc nutzen, um automatisch API-Dokumente aus Programmkommentaren zu generieren, oder automatisch Dokumente generieren, während Sie die Schnittstelle über den passenden RunApi-Client (ein API-Debugging-Tool ähnlich wie Postman) debuggen. Durch die Zuweisung von Projektmitgliedern und Teammitgliedern können Sie Projektdokumentberechtigungen und Teamzusammenarbeit einfach verwalten und Dokumente auch mit Freunden zur Ansicht teilen. ShowDoc unterstützt auch Multiplattform-Clients, einschließlich Win-Client, Mac-Client, iOS, Android usw., was die plattformübergreifende Verwendung erleichtert. Derzeit nutzen mehr als 100.000 Internetteams showdoc, darunter einige Teams bekannter Unternehmen wie Tencent, Huawei, Baidu, JD.com, ByteDance, SF Express usw.

wofür es verwendet werden kann

1. API-Dokumentation

Mit der Entwicklung des mobilen Internets erfreut sich BaaS (Backend as a Service) immer größerer Beliebtheit. Der Server stellt eine API bereit, und die APP oder das Web-Frontend können problemlos Daten abrufen. Mit ShowDoc lassen sich sehr bequem und schnell schöne API-Dokumente schreiben.

2. Datenwörterbuch

Ein gutes Datenwörterbuch kann anderen Ihre Datenbankstruktur leicht erklären, beispielsweise die Definition jedes Felds usw.

3. Dokumentation

Sie können showdoc verwenden, um Anweisungen für einige Tools zu schreiben, und Sie können auch einige technische Spezifikationsdokumente schreiben, die das Team überprüfen kann.

Welche Funktionen hat es

1. Teilen und exportieren

Responsive Webdesign, Projektdokumente können zur Ansicht auf Computern oder Mobilgeräten geteilt werden. Gleichzeitig können Sie das Projekt auch in eine Word-Datei exportieren, um es offline zu durchsuchen.

2. Berechtigungsverwaltung

(1), öffentliche Projekte und private Projekte

Es gibt zwei Arten von Projekten auf ShowDoc: öffentliche Projekte und private Projekte. Auf öffentliche Projekte kann jeder angemeldete oder nicht angemeldete Benutzer zugreifen, während für private Projekte ein Passwort zur Authentifizierung des Zugriffs erforderlich ist. Das Passwort wird vom Projektersteller festgelegt.

(2) Projektübertragung

Projekterstellern steht es frei, Projekte an andere Benutzer der Website zu übertragen.

(3), Projektmitglieder

Sie können ganz einfach Projektmitglieder zu ShowDoc-Projekten hinzufügen und daraus löschen. Projektmitglieder können das Projekt bearbeiten, aber nicht übertragen oder löschen (nur der Projektersteller hat die Berechtigung).

(4), Teammanagement

Mit der Teamfunktion von showdoc können Sie besser mit Ihrem Team zusammenarbeiten

3. Bearbeitungsfunktion

(1), Markdown-Bearbeitung

ShowDoc verwendet den Markdown-Editor, der ein hervorragendes Bearbeitungs- und Leseerlebnis bietet. Wenn Sie Markdown nicht kennen, suchen Sie bitte in der Suchmaschine nach „Grundlegendes und Erste Schritte mit Markdown“.

(2) Einfügen einer Vorlage

Klicken Sie auf der ShowDoc-Bearbeitungsseite auf die Schaltfläche über dem Editor, um ganz einfach API-Schnittstellenvorlagen und Datenwörterbuchvorlagen einzufügen. Nach dem Einfügen der Vorlage müssen nur noch die Daten geändert werden, was viel Bearbeitungsaufwand erspart.

(3), Geschichte

ShowDoc bietet eine Verlaufsfunktion für die Seite und Sie können die Seite problemlos auf den vorherigen Stand zurücksetzen.

4. Multiplattform

showdoc unterstützt die mobile App-Version und die Computer-Client-Version.

5. Automatisierung

(1) Dokumente können automatisch aus Codekommentaren generiert werden

(2), ausgestattet mit RunApi-Client, Debugging-Schnittstelle und automatisch generierten Dokumenten