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