مشروع تريتون

تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول في موسم Google من المستندات.

ملخّص المشروع

مؤسسة مفتوحة المصدر:

Tryton

الكاتب التقني:

dave

اسم المشروع:

مستندات الوحدات الأساسية

مدة المشروع:

المدة العادية (3 أشهر)

وصف المشروع

في هذا المشروع، نقترح مراجعة وتعديل مستندات وحدات Tryton الأساسية. هذه هي الوحدات التي سيحتاج المستخدمون إلى تفعيلها بشكل شائع عند إعداد نظام Tryton.

ستساعد التحسينات التي تم إدخالها على الوحدات التي تتّبعها في Tryton المستخدمين في العثور على الوحدات المناسبة لاحتياجاتهم، ثم مساعدتهم في إعداد نظامهم واستخدامه. ستسمح مستندات الوحدة الجيدة للمستخدمين بالعثور على إجابات عن بعض أسئلتهم الأساسية بدون الحاجة إلى انتظار الإجابات في منتدى المناقشة.

تتضمّن الوحدات الأساسية على الأقل الوحدات التالية: account وaccount_invoice وaccount_invoice_stock وaccount_product وcompany وcountry وcurrency وparty وproduct وpurchase وsale وstock.

هناك ثلاثة شرائح جمهور رئيسية لوثائق Tryton، وهم المستخدمون ومشرفي النظام والمطوّرون. للمساعدة في استهداف الوثائق لكل من هذه الوحدات، أقترح تقسيم وثائق كل وحدة إلى ملفات منفصلة داخل دليل المستند. ويمكن أن تتضمّن هذه الملفات جداول محتويات وأوصافًا للوحدة وتعليمات حول إعدادها ومعلومات عن كيفية استخدامها وتفاصيل عن تصميمها وبنيتها. قد لا تكون بعض هذه الملفات مطلوبة حسب وظائف الوحدة، ويمكن إنشاء ملفات إضافية حسب الحاجة. ستكون تحسينات الوحدة على غرار تلك التي اقترحتها سابقًا لوحدة الطرف: https://codereview.tryton.org/297241003/#ps327231002

سيؤدي تنظيم المستندات على هذا النحو إلى تحقيق نتائج جيدة لأنّ Sphinx ينشئ المستندات حاليًا باستخدام ملفات reStructuredText. عند إجراء تغييرات على المستندات، سيتم تحميلها إلى موقع مراجعة رمز Tryton الإلكتروني، حتى يمكن مراجعتها، ويمكنني تعديلها حسب الحاجة. بعد أن يوافق الجميع على هذه التغييرات، نأمل أن تتم الموافقة على تضمينها في Tryton.