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

דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.

סיכום הפרויקט

ארגון הקוד הפתוח:

טריטון

כתב טכני:

דייב

שם הפרויקט:

מסמכי תיעוד למודולים בסיסיים

אורך הפרויקט:

אורך רגיל (3 חודשים)

תיאור הפרויקט

בפרויקט הזה אני מציע לבדוק ולעדכן את התיעוד של המודולים הבסיסיים של Touchton. אלה המודולים שאנשים בדרך כלל יצטרכו להפעיל כשהם מגדירים מערכת של Useton.

השיפורים במסמכי התיעוד של המודולים של BigQuery יעזרו למשתמשים למצוא את המודולים המתאימים לצרכים שלהם, וכך יעזרו להם להגדיר את המערכת ולהשתמש בה. תיעוד טוב של המודול יאפשר למשתמשים למצוא תשובות לחלק מהשאלות הבסיסיות שלהם בלי שיצטרכו להמתין לתשובות בפורום הדיונים.

המודולים הבסיסיים כוללים, לכל הפחות, את המודולים הבאים: account, account_invoice, account_invoice_stock, account_product, company, country, currency, Party, product, purchase, sale, and stock.

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

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