showdoc オンラインドキュメント共有ツール v3.2.6

その他のカテゴリー

3.2.6

ダウンロード

ShowDoc は、IT チームに最適なオンライン API ドキュメントおよび技術ドキュメントツールです。 showdoc を通じて、マークダウン構文を使用して美しい API ドキュメント、データディクショナリドキュメント、技術ドキュメント、オンライン Excel ドキュメントなどを簡単に作成できます。マークダウンドキュメントを編集したくない場合は、showdoc の自動化機能を使用して、プログラムコメントから API ドキュメントを自動的に生成したり、一致する RunApi クライアント (postman に似た API デバッグツール) からインターフェイスをデバッグしながらドキュメントを自動的に生成したりすることもできます。プロジェクトメンバーとチームメンバーを割り当てることで、プロジェクトドキュメントの権限とチームコラボレーションを簡単に管理でき、ドキュメントを友人と共有して表示することもできます。 ShowDoc は、Win クライアント、Mac クライアント、iOS、Android などのマルチプラットフォームクライアントもサポートしているため、クロスプラットフォームでの使用がより便利になります。現在、100,000 以上のインターネットチームが showdoc を使用しており、その中には Tencent、Huawei、Baidu、JD.com、ByteDance、SF Express などの有名企業内のチームも含まれています。

何に使えるのか

1. APIドキュメント

モバイルインターネットの発展に伴い、BaaS（サービスとしてのバックエンド）の人気が高まっています。サーバーは API を提供し、APP または Web フロントエンドから簡単にデータを呼び出すことができます。 ShowDoc を使用すると、美しい API ドキュメントを非常に便利かつ迅速に作成できます。

2. データディクショナリ

優れたデータディクショナリを使用すると、各フィールドの定義など、データベースの構造を他の人に簡単に説明できます。

3. 文書化

showdoc を使用して一部のツールの手順を作成したり、チームがレビューするための技術仕様文書を作成したりすることもできます。

どのような機能があるのか

1. 共有とエクスポート

レスポンシブ Web デザインでは、プロジェクトドキュメントをコンピューターまたはモバイルデバイスで共有して表示できます。同時に、オフラインで閲覧できるようにプロジェクトを Word ファイルにエクスポートすることもできます。

2. 権限管理

(1)、公共事業と民間事業

ShowDoc には、パブリックプロジェクトとプライベートプロジェクトの 2 種類のプロジェクトがあります。パブリックプロジェクトにはログインユーザーまたは非ログインユーザーがアクセスできますが、プライベートプロジェクトにはアクセスを認証するためのパスワードが必要です。パスワードはプロジェクト作成者が設定します。

(2) プロジェクト移管

プロジェクト作成者は、プロジェクトをサイトの他のユーザーに自由に転送できます。

(3)、プロジェクトメンバー

ShowDoc プロジェクトに対してプロジェクトメンバーを簡単に追加および削除できます。プロジェクトメンバーはプロジェクトを編集できますが、プロジェクトの転送や削除はできません（プロジェクト作成者のみが権限を持っています）

(4)、チームマネジメント

showdoc のチーム機能を使用すると、チームとのコラボレーションが向上します。

3.編集機能

(1)、マークダウン編集

ShowDoc はマークダウンエディターを使用しており、優れた編集および読み取りエクスペリエンスを提供します。 Markdownを知らない場合は、検索エンジンで「Markdownの理解と入門」を検索してください。

(2) テンプレートの挿入

ShowDoc 編集ページで、エディターの上にあるボタンをクリックすると、API インターフェイステンプレートとデータディクショナリテンプレートを簡単に挿入できます。テンプレートを挿入したら、あとはデータを変更するだけなので、編集の手間が大幅に節約されます。

(3)、歴史