أداة مشاركة المستندات عبر الإنترنت showdoc v3.2.6

ShowDoc عبارة عن توثيق API عبر الإنترنت وأداة توثيق فنية مناسبة جدًا لفرق تكنولوجيا المعلومات. من خلال showdoc، يمكنك بسهولة استخدام صيغة تخفيض السعر لكتابة مستندات API جميلة، ومستندات قاموس البيانات، والمستندات الفنية، ومستندات Excel عبر الإنترنت، وما إلى ذلك. إذا كنت لا ترغب في تحرير مستندات تخفيض السعر، فيمكنك أيضًا استخدام إمكانات التشغيل الآلي لـ showdoc لإنشاء مستندات API تلقائيًا من تعليقات البرنامج، أو إنشاء المستندات تلقائيًا أثناء تصحيح أخطاء الواجهة من عميل RunApi المطابق (أداة تصحيح أخطاء واجهة برمجة التطبيقات المشابهة لـ Postman). من خلال تعيين أعضاء المشروع وأعضاء الفريق، يمكنك بسهولة إدارة أذونات مستندات المشروع وتعاون الفريق، ويمكنك أيضًا مشاركة المستندات مع الأصدقاء للعرض. يدعم ShowDoc أيضًا عملاء متعددي المنصات، بما في ذلك Win Client وMac Client وiOS وAndroid وما إلى ذلك، مما يجعله أكثر ملاءمة للاستخدام عبر الأنظمة الأساسية. في الوقت الحالي، يستخدم أكثر من 100.000 فريق إنترنت showdoc، بما في ذلك بعض الفرق التابعة لشركات معروفة، مثل Tencent وHuawei وBaidu وJD.com وByteDance وSF Express وما إلى ذلك.

ما يمكن استخدامه ل

1. وثائق API

مع تطور الإنترنت عبر الهاتف المحمول، أصبحت BaaS (الواجهة الخلفية كخدمة) أكثر شيوعًا. يوفر الخادم واجهة برمجة التطبيقات (API)، ويمكن للتطبيق أو الواجهة الأمامية للويب الاتصال بالبيانات بسهولة. يمكن استخدام ShowDoc لكتابة مستندات API جميلة بسهولة وسرعة.

2. قاموس البيانات

يمكن لقاموس البيانات الجيد أن يشرح بسهولة بنية قاعدة البيانات الخاصة بك للآخرين، مثل تعريف كل حقل، وما إلى ذلك.

3. التوثيق

يمكنك استخدام showdoc لكتابة تعليمات لبعض الأدوات، ويمكنك أيضًا كتابة بعض مستندات المواصفات الفنية ليقوم الفريق بمراجعتها.

ما هي الوظائف التي لديها

1. شارك وتصدير

تصميم ويب سريع الاستجابة، يمكن مشاركة مستندات المشروع على أجهزة الكمبيوتر أو الأجهزة المحمولة للعرض. وفي الوقت نفسه، يمكنك أيضًا تصدير المشروع إلى ملف Word للتصفح دون الاتصال بالإنترنت.

2. إدارة الأذونات

(1) المشاريع العامة والمشاريع الخاصة

هناك نوعان من المشاريع في ShowDoc: المشاريع العامة والمشاريع الخاصة. يمكن الوصول إلى المشاريع العامة بواسطة أي مستخدم قام بتسجيل الدخول أو لم يقوم بتسجيل الدخول، بينما تتطلب المشاريع الخاصة كلمة مرور لمصادقة الوصول. يتم تعيين كلمة المرور من قبل منشئ المشروع.

(2) نقل المشروع

يتمتع منشئو المشاريع بحرية نقل المشاريع إلى مستخدمين آخرين للموقع.

(3) أعضاء المشروع

يمكنك بسهولة إضافة وحذف أعضاء المشروع إلى مشاريع ShowDoc. يمكن لأعضاء المشروع تحرير المشروع، ولكن لا يمكنهم نقل المشروع أو حذفه (فقط منشئ المشروع لديه الإذن بذلك)

(٤) إدارة الفريق

يمكنك التعاون بشكل أفضل مع فريقك باستخدام وظيفة فريق showdoc

3. وظيفة التحرير

(١) أي تحرير التخفيض

يستخدم ShowDoc محرر تخفيض السعر، الذي يوفر تجربة تحرير وقراءة ممتازة. إذا كنت لا تعرف Markdown، فيرجى البحث عن "الفهم والبدء باستخدام Markdown" في محرك البحث

(2) إدراج القالب

في صفحة تحرير ShowDoc، انقر فوق الزر الموجود أعلى المحرر لإدراج قوالب واجهة API وقوالب قاموس البيانات بسهولة. بعد إدراج القالب، كل ما تبقى هو تغيير البيانات، مما يوفر الكثير من جهد التحرير.

(٣)، التاريخ

يوفر ShowDoc وظيفة محفوظات للصفحة، ويمكنك بسهولة استعادة الصفحة إلى الصفحة السابقة.

4. منصة متعددة

يدعم showdoc إصدار تطبيق الهاتف المحمول وإصدار عميل الكمبيوتر.

5. الأتمتة

(1) يمكن إنشاء المستندات تلقائيًا من تعليقات التعليمات البرمجية

(2)، مزود بعميل RunApi وواجهة تصحيح الأخطاء وإنشاء المستندات تلقائيًا