פרויקט ניסיון

בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית 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.

התיעוד של טריטון, משתמשים, מנהלי מערכת ומפתחים מחולקים לשלושה קהלים עיקריים. כדי לטרגט את המסמכים לכל אחד מהם, מומלץ לפצל את המסמכים של כל מודול לקובצי doc נפרדים בספריית doc. קבצים כאלה יכולים לכלול קובץ תוכן ותיאור של המודול, הוראות להגדרת המודול, מידע על השימוש בו ופרטים על העיצוב והמבנה של המודול. בהתאם לפונקציונליות של המודול, יכול להיות שחלק מהקבצים האלה לא נדרשים, ואפשר ליצור קבצים נוספים לפי הצורך. השיפורים במודול יהיו דומים לאלה שכבר הצעתי למודול הצד: https://codereview.tryton.org/297241003/#ps327231002

המבנה הזה של המסמכים יתאים מאוד, כי המסמכים נוצרים כרגע על ידי Sphinx באמצעות קובצי reStructuredText. כשאעשה שינויים במסמכי העזרה, הם יעלו לאתר לבדיקה של קוד Tryton כדי שאפשר יהיה לבדוק אותם, ואוכל לעדכן אותם לפי הצורך. לאחר שכולם יהיו מרוצים, הם יוכלו לקבל אישור להיכלל ב-Triton.