مشروع تريتون
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول في
موسم 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.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2024-11-08 (حسب التوقيت العالمي المتفَّق عليه)
[[["يسهُل فهم المحتوى.","easyToUnderstand","thumb-up"],["ساعَدني المحتوى في حلّ مشكلتي.","solvedMyProblem","thumb-up"],["غير ذلك","otherUp","thumb-up"]],[["لا يحتوي على المعلومات التي أحتاج إليها.","missingTheInformationINeed","thumb-down"],["الخطوات معقدة للغاية / كثيرة جدًا.","tooComplicatedTooManySteps","thumb-down"],["المحتوى قديم.","outOfDate","thumb-down"],["ثمة مشكلة في الترجمة.","translationIssue","thumb-down"],["مشكلة في العيّنات / التعليمات البرمجية","samplesCodeIssue","thumb-down"],["غير ذلك","otherDown","thumb-down"]],["تاريخ التعديل الأخير: 2024-11-08 (حسب التوقيت العالمي المتفَّق عليه)"],[[["This project aims to enhance the documentation of Tryton's basic modules, making it easier for users to understand and utilize them effectively."],["The documentation will be restructured for better clarity and accessibility, targeting users, administrators, and developers with separate sections for setup, usage, and design."],["The project focuses on essential modules such as account, product, purchase, sale, and stock, crucial for setting up a Tryton system."],["Proposed improvements will follow a structured approach, similar to those suggested for the party module, and will undergo thorough review on Tryton's code review site."],["These improvements will empower users with self-service resources, reducing reliance on external support and facilitating a smoother Tryton experience."]]],["The project focuses on enhancing the documentation for Tryton's basic modules, including account, product, and stock. The technical writer will review and update these modules' documentation to assist users in setup and usage. Documentation will be segmented into files for module descriptions, setup, usage, and design. Changes will be submitted to the Tryton code review site for feedback and approval. The goal is to help users and administrators with their common questions and use of the software.\n"]]
