مشروع تريتون

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

ملخص المشروع

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

التريتون

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

ديف

اسم المشروع:

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

مدة المشروع:

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

وصف المشروع

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

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

تتضمن الوحدات الأساسية كحد أدنى ما يلي: account_invoice_stock وaccount_invoice_stock وaccount_product وCompany والبلد والعملة والطرف والمنتج والشراء والبيع ووحدات المخزون.

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

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