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