outil de partage de documents en ligne showdoc v3.2.6

ShowDoc est un outil de documentation API et de documentation technique en ligne très adapté aux équipes informatiques. Grâce à showdoc, vous pouvez facilement utiliser la syntaxe markdown pour rédiger de superbes documents API, des documents de dictionnaire de données, des documents techniques, des documents Excel en ligne, etc. Si vous ne souhaitez pas modifier les documents markdown, vous pouvez également utiliser les capacités d'automatisation de showdoc pour générer automatiquement des documents API à partir des commentaires du programme, ou générer automatiquement des documents tout en débogant l'interface à partir du client RunApi correspondant (un outil de débogage API similaire à postman). En affectant des membres du projet et des membres de l'équipe, vous pouvez facilement gérer les autorisations des documents de projet et la collaboration en équipe, et vous pouvez également partager des documents avec des amis pour les consulter. ShowDoc prend également en charge les clients multiplateformes, notamment le client Win, le client Mac, iOS, Android, etc., ce qui le rend plus pratique pour une utilisation multiplateforme. Actuellement, plus de 100 000 équipes Internet utilisent showdoc, y compris certaines équipes d'entreprises bien connues, telles que Tencent, Huawei, Baidu, JD.com, ByteDance, SF Express, etc.

à quoi peut-il servir

1.Documentation API

Avec le développement de l’Internet mobile, le BaaS (backend as a service) devient de plus en plus populaire. Le serveur fournit une API et l'application ou le front-end Web peut facilement appeler des données. ShowDoc peut être utilisé pour rédiger de superbes documents API de manière très pratique et rapide.

2. Dictionnaire de données

Un bon dictionnaire de données peut facilement expliquer la structure de votre base de données aux autres, comme la définition de chaque champ, etc.

3.Documents

Vous pouvez utiliser showdoc pour rédiger des instructions pour certains outils, et vous pouvez également rédiger des documents de spécifications techniques que l'équipe pourra examiner.

Quelles fonctions a-t-il

1. Partager et exporter

Conception Web réactive, les documents de projet peuvent être partagés sur des ordinateurs ou des appareils mobiles pour être visualisés. Dans le même temps, vous pouvez également exporter le projet dans un fichier Word pour une navigation hors ligne.

2. Gestion des autorisations

(1), projets publics et projets privés

Il existe deux types de projets sur ShowDoc : les projets publics et les projets privés. Les projets publics sont accessibles à tout utilisateur connecté ou non connecté, tandis que les projets privés nécessitent un mot de passe pour authentifier l'accès. Le mot de passe est défini par le créateur du projet.

(2) Transfert de projet

Les créateurs de projets sont libres de transférer leurs projets à d'autres utilisateurs du site.

(3), membres du projet

Vous pouvez facilement ajouter et supprimer des membres de projet aux projets ShowDoc. Les membres du projet peuvent modifier le projet, mais ne peuvent pas transférer ou supprimer le projet (seul le créateur du projet en a l'autorisation)

(4), gestion d'équipe

Vous pouvez mieux collaborer avec votre équipe en utilisant la fonction d'équipe de showdoc

3. Fonction d'édition

(1), édition de démarques

ShowDoc utilise un éditeur de démarques, qui offre une excellente expérience d'édition et de lecture. Si vous ne connaissez pas Markdown, veuillez rechercher « Comprendre et démarrer avec Markdown » dans le moteur de recherche.

(2) Insertion de modèle

Sur la page d'édition ShowDoc, cliquez sur le bouton au-dessus de l'éditeur pour insérer facilement des modèles d'interface API et des modèles de dictionnaire de données. Après avoir inséré le modèle, il ne reste plus qu'à modifier les données, ce qui économise beaucoup d'efforts d'édition.

(3), histoire

ShowDoc fournit une fonction d'historique pour la page et vous pouvez facilement restaurer la page à la précédente.

4. Multi-plateforme

showdoc prend en charge la version de l'application mobile et la version du client informatique.

5. Automatisation

(1) Les documents peuvent être générés automatiquement à partir des commentaires de code

(2), équipé du client RunApi, d'une interface de débogage et de génération automatique de documents