หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- Tryton
- นักเขียนเชิงเทคนิค
- dave
- ชื่อโปรเจ็กต์:
- เอกสารสำหรับโมดูลพื้นฐาน
- ระยะเวลาของโปรเจ็กต์
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
ในโปรเจ็กต์นี้ เราขอเสนอให้ตรวจสอบและอัปเดตเอกสารประกอบสำหรับโมดูล Tryton พื้นฐาน โมดูลเหล่านี้คือโมดูลที่ผู้คนมักจะต้องเปิดใช้งานมากที่สุดเมื่อตั้งค่าระบบ Tryton
การปรับปรุงเอกสารประกอบเกี่ยวกับโมดูลของ Tryton จะช่วยให้ผู้ใช้พบโมดูลที่เหมาะกับความต้องการ ทั้งยังช่วยให้ผู้ใช้ตั้งค่าและใช้ระบบของตนเองได้ เอกสารประกอบที่ยอดเยี่ยมของโมดูลจะช่วยให้ผู้ใช้พบคำตอบสำหรับคำถามพื้นฐานบางข้อได้โดยไม่ต้องรอคำตอบในฟอรัมการสนทนา
โมดูลพื้นฐานอย่างน้อยต้องมี account, account_invoice, account_invoice_stock, account_product, company, country, currency, party, product, purchase, sale และ stock
เอกสารประกอบของ Tryton มีกลุ่มเป้าหมายหลัก 3 กลุ่ม ได้แก่ ผู้ใช้ ผู้ดูแลระบบ และนักพัฒนาซอฟต์แวร์ เราขอแนะนำให้แยกเอกสารประกอบของโมดูลแต่ละรายการออกเป็นไฟล์แยกต่างหากในไดเรกทอรีเอกสารประกอบ เพื่อช่วยกำหนดเป้าหมายเอกสารประกอบไปยังแต่ละรายการ ซึ่งอาจรวมถึงไฟล์ที่มีสารบัญและคําอธิบายของข้อบังคับ วิธีการตั้งค่าข้อบังคับ ข้อมูลเกี่ยวกับวิธีใช้ข้อบังคับ และรายละเอียดเกี่ยวกับการออกแบบและโครงสร้างของข้อบังคับ คุณอาจไม่จําเป็นต้องใช้ไฟล์เหล่านี้บางไฟล์ ทั้งนี้ขึ้นอยู่กับฟังก์ชันการทํางานของข้อบังคับ และสามารถสร้างไฟล์เพิ่มเติมได้ตามต้องการ การปรับปรุงโมดูลจะเป็นไปตามแนวทางที่เราได้เสนอไว้สำหรับโมดูลบุคคลแล้วที่ https://codereview.tryton.org/297241003/#ps327231002
การจัดโครงสร้างเอกสารในลักษณะนี้จะได้ผลดี เนื่องจากในปัจจุบันเอกสารดังกล่าวสร้างโดย Sphinx โดยใช้ไฟล์ restructuredText เมื่อเราทําการเปลี่ยนแปลงเอกสารประกอบ ระบบจะอัปโหลดเอกสารประกอบไปยังเว็บไซต์ตรวจสอบโค้ดของ Tryton เพื่อให้ตรวจสอบได้ และเราอัปเดตเอกสารประกอบได้ตามต้องการ เมื่อทุกคนพอใจกับฟีเจอร์เหล่านี้แล้ว ก็หวังว่าจะได้รับอนุมัติให้รวมไว้ใน Tryton