تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخّص المشروع
- مؤسسة مفتوحة المصدر:
- SymPy
- الكاتب الفني:
- lglattly
- اسم المشروع:
- الاتساق في جميع مستندات وصف الدوال البرمجية
- مدة المشروع:
- مدة زمنية عادية (3 أشهر)
وصف المشروع
في هذا المشروع، أسعى إلى تحقيق اتساق أكبر في ملفات نص وصف الدوال البرمجية في SymPy.
بالتعاون مع المرشدين، كنت أحدّد أولاً التنسيق المطلوب لسلسلة وصف الدوال البرمجية في قاعدة البيانات. سأنشئ بعد ذلك دليلًا لتنسيق المستندات لجميع مستندات وصف الدوالّ في قاعدة البيانات التي يجب اتّباعها. سيشمل عملي في المشروع أيضًا تنفيذ الدليل الجديد لتعديل سلاسل المستندات الحالية، أثناء جمع ومعالجة حالات عدم الاتساق الأخرى مثل استخدام اللغة أو المصطلحات. سأتّخذ أنا ومستشاري قرارات تحريرية بشأن كيفية التعامل مع هذه التناقضات الإضافية، وسيتم أيضًا إضافة الإعدادات المفضّلة للأسلوب الناتج إلى الدليل.
سيكون الهدف النهائي من المشروع هو إنشاء دليل تنسيق وأسلوب للمستندات يمكن للمطوّرين والمساهمين استخدامه للمساعدة في الحفاظ على الاتساق في مستندات SymPy الآن وفي المستقبل.