เครื่องมือแบ่งปันเอกสารออนไลน์ showdoc v3.2.6

ShowDoc คือเอกสาร API ออนไลน์และเครื่องมือเอกสารทางเทคนิคที่เหมาะสำหรับทีมไอที คุณสามารถใช้ showdoc ไวยากรณ์มาร์กดาวน์เพื่อเขียนเอกสาร API ที่สวยงาม เอกสารพจนานุกรมข้อมูล เอกสารทางเทคนิค เอกสาร Excel ออนไลน์ ฯลฯ ได้อย่างง่ายดาย หากคุณไม่ต้องการแก้ไขเอกสารมาร์กดาวน์ คุณยังสามารถใช้ความสามารถอัตโนมัติของ showdoc เพื่อสร้างเอกสาร API โดยอัตโนมัติจากความคิดเห็นของโปรแกรม หรือสร้างเอกสารโดยอัตโนมัติในขณะที่แก้ไขจุดบกพร่องอินเทอร์เฟซจากไคลเอนต์ RunApi ที่ตรงกัน (เครื่องมือแก้ไขข้อบกพร่อง API ที่คล้ายกับบุรุษไปรษณีย์) ด้วยการมอบหมายสมาชิกโครงการและสมาชิกในทีม คุณสามารถจัดการสิทธิ์ในเอกสารโครงการและการทำงานร่วมกันในทีมได้อย่างง่ายดาย และคุณยังสามารถแชร์เอกสารกับเพื่อน ๆ เพื่อดูได้อีกด้วย ShowDoc ยังรองรับไคลเอนต์หลายแพลตฟอร์ม รวมถึงไคลเอนต์ win, ไคลเอนต์ mac, ios, android และอื่น ๆ ทำให้สะดวกยิ่งขึ้นสำหรับการใช้งานข้ามแพลตฟอร์ม ปัจจุบันมีทีมอินเทอร์เน็ตมากกว่า 100,000+ ทีมที่ใช้งาน Showdoc รวมถึงบางทีมในบริษัทชื่อดัง เช่น Tencent, Huawei, Baidu, JD.com, ByteDance, SF Express เป็นต้น

มันใช้ทำอะไรได้บ้าง

1. เอกสาร API

ด้วยการพัฒนาอินเทอร์เน็ตบนมือถือ BaaS (แบ็กเอนด์เป็นบริการ) กำลังได้รับความนิยมมากขึ้นเรื่อยๆ เซิร์ฟเวอร์มี API และแอปหรือส่วนหน้าของเว็บสามารถเรียกข้อมูลได้อย่างง่ายดาย ShowDoc สามารถใช้เขียนเอกสาร API ที่สวยงามได้อย่างสะดวกและรวดเร็ว

2. พจนานุกรมข้อมูล

พจนานุกรมข้อมูลที่ดีสามารถอธิบายโครงสร้างฐานข้อมูลของคุณให้ผู้อื่นทราบได้อย่างง่ายดาย เช่น คำจำกัดความของแต่ละฟิลด์ เป็นต้น

3. เอกสารประกอบ

คุณสามารถใช้ showdoc เพื่อเขียนคำแนะนำสำหรับเครื่องมือบางอย่างได้ และคุณยังสามารถเขียนเอกสารข้อกำหนดทางเทคนิคบางอย่างเพื่อให้ทีมตรวจสอบได้อีกด้วย

มันมีฟังก์ชั่นอะไรบ้าง

1. แบ่งปันและส่งออก

การออกแบบเว็บไซต์ที่ตอบสนอง เอกสารโครงการสามารถแชร์ไปยังคอมพิวเตอร์หรืออุปกรณ์เคลื่อนที่เพื่อดูได้ ในเวลาเดียวกัน คุณยังสามารถส่งออกโปรเจ็กต์เป็นไฟล์เวิร์ดสำหรับการเรียกดูแบบออฟไลน์ได้

2. การจัดการสิทธิ์

(1) โครงการสาธารณะและโครงการเอกชน

โปรเจ็กต์บน ShowDoc มีสองประเภท: โปรเจ็กต์สาธารณะและโปรเจ็กต์ส่วนตัว โครงการสาธารณะสามารถเข้าถึงได้โดยผู้ใช้ที่เข้าสู่ระบบหรือไม่ได้เข้าสู่ระบบ ในขณะที่โครงการส่วนตัวต้องใช้รหัสผ่านในการตรวจสอบสิทธิ์การเข้าถึง รหัสผ่านถูกกำหนดโดยผู้สร้างโครงการ

(2) การโอนโครงการ

ผู้สร้างโครงการมีอิสระในการโอนโครงการไปยังผู้ใช้รายอื่นของไซต์

(3) สมาชิกโครงการ

คุณสามารถเพิ่มและลบสมาชิกโครงการในโครงการ ShowDoc ได้อย่างง่ายดาย สมาชิกโปรเจ็กต์สามารถแก้ไขโปรเจ็กต์ได้ แต่ไม่สามารถโอนหรือลบโปรเจ็กต์ได้ (เฉพาะผู้สร้างโปรเจ็กต์เท่านั้นที่ได้รับอนุญาต)

(4) การจัดการทีม

คุณสามารถทำงานร่วมกับทีมของคุณได้ดียิ่งขึ้นโดยใช้ฟังก์ชันทีมของ showdoc

3. ฟังก์ชั่นการแก้ไข

(1) การแก้ไขมาร์กดาวน์

ShowDoc ใช้เครื่องมือแก้ไขมาร์กดาวน์ ซึ่งมอบประสบการณ์การแก้ไขและการอ่านที่ยอดเยี่ยม หากคุณไม่รู้จัก Markdown โปรดค้นหาคำว่า “ทำความเข้าใจและเริ่มต้นใช้งาน Markdown” ในเครื่องมือค้นหา

(2) การแทรกเทมเพลต

บนหน้าการแก้ไข ShowDoc ให้คลิกปุ่มเหนือตัวแก้ไขเพื่อแทรกเทมเพลตอินเทอร์เฟซ API และเทมเพลตพจนานุกรมข้อมูลได้อย่างง่ายดาย หลังจากแทรกเทมเพลตแล้ว สิ่งที่เหลืออยู่คือการเปลี่ยนแปลงข้อมูล ซึ่งช่วยลดความยุ่งยากในการแก้ไขได้มาก

(3) ประวัติศาสตร์

ShowDoc มีฟังก์ชันประวัติสำหรับเพจ และคุณสามารถคืนค่าเพจกลับไปเป็นเพจก่อนหน้าได้อย่างง่ายดาย

4. หลากหลายแพลตฟอร์ม

showdoc รองรับเวอร์ชันแอปมือถือและเวอร์ชันไคลเอนต์คอมพิวเตอร์

5. ระบบอัตโนมัติ

(1) สามารถสร้างเอกสารได้โดยอัตโนมัติจากความคิดเห็นของโค้ด

(2) ติดตั้งไคลเอนต์ RunApi อินเทอร์เฟซการดีบักและสร้างเอกสารโดยอัตโนมัติ