تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخص المشروع
- مؤسسة مفتوحة المصدر:
- Django
- الكاتب الفني:
- Gabbyprecious
- اسم المشروع:
- إعادة كتابة دليل المساهمة ليكون أكثر ملاءمةً للمستخدمين ويسهل التنقّل فيه
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
ABSTRACT
والهدف من دليل المساهمات من Django مثل كل المستندات الأخرى هو تقديم الإرشادات من المستخدمين والمساهمين المفتوحين المصدر في هذه الحالة حول كيفية وأين يمكنهم المساهمة في تحسين Django واستدامتها.
هناك حاجة دائمًا إلى إنشاء مستندات، خاصةً تلك التي تؤثر بشكل كبير في المنتدى وDjango نفسه.
هدف Django في "موسم مستندات Google" لهذا العام هو جعل دليل المساهمة أقلّ إرباكًا وأكثر سهولة وترحيبًا للمساهمين. هذا هدف أساسي لأنّه يشجع المساهمين، ومن بينهم أنا، على البدء بالمساهمة في هذا الإطار العملي الرائع.
الحالة الحالية
إنّ المرحلة الحالية من المستندات التي يمكن العثور عليها هنا ليست دليلاً جيدًا لأنّها مكثفة جدًا وغير منظَّمة بشكل جيد، ما يؤدي إلى فهم أقل للمساهمة في Django وعدم الترحيب بالمساهمين الجدد.
أهداف المشروع
لقد ناقشت اقتراحاتي بشأن المستندات مع المرشد الخاص بي، "كارلتون جيبسون"، في المنتدى، وأقرّ بأنّها ستساعد في حلّ المشكلة الملحة في المستندات الحالية. في ما يلي الأهداف التي أخطّط لتحقيقها من خلال إعادة تنظيم المستند: إعادة تنظيم المستند إضافة إجراءات يجب اتّباعها وأخرى يجب تجنّبها في كل قسم إنشاء صفحات فردية للأقسام البسيطة، مثل طلب الميزات وإنشائها مستندات مختصرة ومباشرة تهدف إلى توصيل المعلومات بوضوح مسرد للكلمات فهرس داخلي تم إنشاؤه لاتّباع الدليل الجديد كتابة مستندات أكثر سهولة ووضوحًا تقسيم المحتوى إلى قسمَين رئيسيَّين (قسم للمبتدئين وقسم للمساهمين المتقدّمين) إنشاء دليل وأسلوب للكتاب التقنيين/المساهمين الجدد، من أجل إبقاء المستندات محدّثة ومتوافقة مع المعايير
تستهدف المستندات الحالية المشارِكين المتقدّمين، ولا تمنح فرصة للمشارِكين الجدد والمبتدئين في كلّ من المصدر المفتوح وDjango. في ما يلي بعض المحتوى الإضافي للمبتدئين: قسم يوجّه مجموعة مختلفة من المشارِكين(الكتاب الفنيون والمصمّمون والمطوّرون) صفحة تسجّل المشاكل التي يواجهها المستخدمون لأول مرة والمشاكل السهلة التي يمكن حلّها. اختَر بعض الأقسام في المستندات الحالية وأعِد كتابتها وأضِفها إلى قسم "المبتدئون". الأقسام التي تشرح النقاط أو الكلمات الرئيسية المستخدَمة في القسم المتقدّم
المخطط الزمني
في ما يلي تفاصيل حول كيفية العمل على هدف المشروع كما هو موضّح أعلاه باستخدام التقويم المقدَّم من Google.
الأدوات
Sphinx: الأداة الحالية لإنشاء المستندات الحالية اقرأ المستندات.
لماذا هذا المشروع؟
وأنا من المؤمنين الأساسيين بالمستندات والمقالات المكتوبة بأسلوب جيّد تساعدك في توسيع نطاق توفّر الجميع في جميع أنحاء العالم. فضلاً عن ذلك، أحب استخدام Django وبرنامج Open المصدر بشكل عام. كنت أريد المساهمة في Django كمبتدئ وأعتقد أنّ هذه هي الطريقة المثالية للمساهمة في أداتي المفضّلة، مع التعرّف أيضًا على قاعدة البيانات لتقديم مزيد من المساهمات كمطوّر(وكاتب فني). سيكون من الجميل العمل مع مؤسسة تتوافق مع وجهات نظري وتكون أداة رائعة لمسيرتي المهنية بأكملها.
لماذا أنا الشخص المناسب لهذا المشروع؟
أعتقد أنّني الشخص المناسب بناءً على الحسابات التالية: لقد كنت أساهم في Django من خلال كتابة مقالات لمساعدة المبتدئين في فهم مفهوم Django بشكل أفضل. بصفتي مطوّرًا وأتطلّع إلى المساهمة في Django، أتفهّم احتياجات زملائي المطوّرين وكيفية توثيقها بشكل جيد لهم. أنا عضو في فريق وأعمل بشكل جيد تحت إشراف مرشدي "كارلتون جيبسون" بغض النظر عن مستوى الإشراف.