تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول ضمن "موسم المستندات" من Google.
ملخص المشروع
- مؤسسة البرامج المفتوحة المصدر:
- DIPY
- الكاتب الفني:
- أريشا طارق
- اسم المشروع:
- إعادة هيكلة عالية المستوى وتركيز المستخدم النهائي
- طول المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
أنا مهندس برمجيات ولدي خبرة في الكتابة الفنية. لدي أكثر من 4 سنوات من الخبرة في كتابة وثائق البرامج عالية الجودة وأدلة المستخدم والكتيبات وأوصاف المشروعات. أقيم في إسلام آباد، باكستان (المنطقة الزمنية: التوقيت العالمي المنسَّق (UTC) + 5). أعمل حاليًا كمتدرب في برنامج التوعية ويستمر حتى 18 آب (أغسطس). شاركت في موسم "مستندات Google" ككاتب فني في مؤسسة OpenELIS Global. كانت الوثائق الأصلية باللغة الفرنسية، ومحدودة، والقديمة، لذلك أنشأت وثائق شاملة ومحدثة للمستخدم باللغة الإنجليزية. تم اختياري في التوعية في مؤسسة Perl & Raku في الفترة بين أيار (مايو) وآب (أغسطس) 2020 كمطوِّر خلفية لخادم Open Food Facts. إلى جانب التطوير الخلفي، تتمثل إحدى المهام الرئيسية لهذا التدريب الداخلي في إنشاء وثائق للوحدات والوظائف بتنسيق POD. لقد دخلت إلى عالم البرامج مفتوحة المصدر في العام الماضي عندما ساهمت في بعض المشاريع مفتوحة المصدر وشاركت لاحقًا في موسم المستندات من Google. وهذا العام، تم اختياري في التوعية التي تدعم التنوع في البرامج مفتوحة المصدر والبرامج المجانية. لدي خبرة كبيرة في Git حيث تتم استضافة مشروع التوعية الخاص بي على GitHub وقد قمت بتقديم مساهمات منتظمة في Open Food Facts وMozilla Fenix منذ آذار (مارس). أنا أستخدم نظام التشغيل Linux منذ أكثر من 3 سنوات وأستخدم أوامر الوحدة الطرفية منذ ذلك الحين.
أدوات التوثيق واللغات التي استخدمتها هي Sphinx وRead the docs و Markdown. لقد أحببت هذه الفكرة وأريد العمل على تطويرها لأن لديّ خبرة ذات صلة وأودّ استخدام معرفتي ومهاراتي للمساهمة في DIPY. لدي خبرة في مجال معالجة الصور الرقمية ورؤية الكمبيوتر والتعلم الآلي. سيساعدني ذلك في فهم التصوير العصبي بشكل أفضل والمساعدة في إعداد الوثائق. لدي خبرة واسعة في المجال الطبي. أنشأت موقعًا إلكترونيًا طبيًا للأطباء والمرضى والمختبرات وسائقي سيارات الإسعاف. عملت على نظام آخر يستخدمه الأطباء والمرضى والممرضات ومساعدو المختبرات والباحثون. سيساعدني ذلك في إنشاء وثائق يسهل فهمها من قبل الجمهور.
لقد راجعت وثائق DIPY ولاحظت العديد من العيوب في الوثائق. هناك ثغرات متعددة في الوثائق التي أخطط لتحسينها. الوضع الحالي للوثائق: تفتقر الوثائق إلى بنية وتصميم محددين قد تكون مملة وتستغرق وقتًا طويلاً، لا سيما بالنسبة إلى المستخدمين الجدد للتنقل قد يواجه المستخدمون صعوبة في الحصول على معلومات من الدليل يحتاج محتوى الوثائق إلى تحسين بصفتي مستخدمًا جديدًا، وجدت أنه من الصعب الوصول إلى دليل المستخدم ودليل المطور. يجب إعادة تشكيل الوثائق بطريقة تجعل المعلومات التي يطلبها المستخدم يسهل الوصول إليها تفتقر الوثائق إلى الاتساق
أنوي القيام بما يلي:
تحديد هيكل ونموذج محدد للوثائق إعادة تشكيل الوثائق بحيث يمكن للمستخدمين التنقل والعثور على المعلومات المطلوبة بسهولة إنشاء خارطة طريق أو قائمة عناصر العمل لإشراك المجتمع في المزيد من أعمال التوثيق تحديد قوالب لدليل المستخدم ودليل المطور تحديد نماذج لدليل المساهمة إعادة كتابة واجهة المستخدم وإعادة هيكلةها وتحديثها ودليل التطوير ودليل المساهمة (يمكن أن يساعد في تحسين الوثائق الجديدة وتحفيز المستخدمين الجدد
دليل المستخدم:
بالنسبة لدليل المستخدم، أود أن أركز على استخدام لغة بسيطة وعادية لمساعدة المستخدمين على فهم حتى الأنظمة الأكثر تعقيدًا. سيتم تجنب المصطلحات الاصطلاحية والاختصارات وغيرها من المعلومات الداخلية التي قد لا يعرفها المستخدم الجديد لتحسين تجربة المستخدم. سأركز أيضًا على استخدام المحتوى المرئي، بما في ذلك الصور ولقطات الشاشة التوضيحية والرسومات ومقاطع الفيديو، والذي يوضح للمستخدم بسرعة كيفية عمل النظام. تحتاج الوثائق الجيدة إلى تسلسل هرمي من العناوين والعناوين الفرعية التي تتيح للمستخدم معرفة ما سيعرضه كل قسم. ويجب أن يتبع هذا التسلسل الهرمي تدفقًا منطقيًا يساعد المستخدم على تعلم استخدام النظام بالطريقة الأكثر فائدة. سيكون أحد الأهداف الرئيسية لهذا المشروع هو إنشاء محتوى يمكن الوصول إليه. ستلتزم جميع الوثائق والأدلة بأسلوب متسق. يعد استخدام خطوط متسقة وألوان تكميلية في مستندات متعددة أمرًا ضروريًا. سأتأكد من أن المستخدمين لديهم إمكانية الوصول إلى المزيد من موارد المؤسسة حول كيفية النجاح مع النظام.
دليل المطوّر:
يتضمن دليل المطوّر إرشادات شاملة ومواد مرجعية لمساعدة المطوّر في إنشاء المساهمات في عملية الترميز المصدر لـ DIPY. إنه يحاول تحديد الخيارات المختلفة المتاحة لك، حتى تتمكن من استخدام الطريقة الصحيحة، اعتمادًا على ما تريد تحقيقه. يحتاج دليل التطوير إلى إعادة تشكيل وإعادة الهيكلة. سأعيد كتابة محتوى دليل المطوّر. سيتم تضمين بناء التبعيات، ودليل المساهمة، ودليل الأسلوب، واصطلاحات الترميز، ودليل التوثيق، وتركيب بيئة التطوير، وتصحيح الأخطاء، ودليل الاختبار، والعناصر ذات الصلة، ويمكن للمطورين الوصول إليها بسهولة. عندما يندفع المساهمون الجدد المتحمسون إلى مشروعك لتقديم أول مساهمة مفتوحة المصدر، يعتمدون على إرشادات المساهمة لتكون دليلهم. وبالتالي ستكون الإرشادات سهلة القراءة وشاملة وودية. أدلة المساهمة هي وثائق مفيدة توضح كيف يمكن للأشخاص المساهمة في المشروع مفتوح المصدر. يجب أن تكون المساهمة في المشروع سهلة وشفافة قدر الإمكان للمستخدمين، سواء كان ذلك: تقديم إصلاح الإبلاغ عن خطأ العمل على الصيانة مناقشة الحالة الراهنة للرمز اقتراح ميزات جديدة
TEMPLATE
هذا أحد النماذج التي يمكن استخدامها في دليل المساهمة. ويمكن تعديله وإضافة أقسام أو إزالتها وفقًا لمتطلبات المستند.
المساهمة في DIPY
- كلمة ترحيبية
جدول المحتويات
مدوّنة السلوك
- معاييرنا
- أمثلة على السلوكيات التي تساهم في خلق بيئة إيجابية
- أمثلة على سلوك المشاركين غير المقبول
- مسؤولياتنا
- مسئوليات من الحفاظ على المشروع
- النطاق
نطاق مدوّنة السلوك
ما الذي أحتاج إلى معرفته للمساعدة؟
إذا كنت تريد المساعدة بخصوص مساهمة الرموز في مشروعنا، ما عليك سوى إدراجه [إدراج قائمة بلغات البرمجة أو أُطر العمل أو الأدوات التي يستخدمها مشروعك]. إذا لم تكن مستعدًا لتقديم مساهمة بالرمز، لا مشكلة في ذلك. يمكنك أيضًا الاطلاع على مشكلات الوثائق [link to the docs label or tag on your issue tracker] أو مشكلات التصميم التي لدينا [link to design التسمية أو وضع علامة على أداة تتبع المشكلات إذا كان مشروعك يتتبع مشكلات التصميم]. إذا كنت مهتمًا بتقديم رمز برمجي وأردت معرفة المزيد من المعلومات عن التكنولوجيات التي نستخدمها، يمكنك الاطّلاع على القائمة أدناه. قم بتضمين قائمة نقطية بالموارد (البرامج التعليمية ومقاطع الفيديو والكتب) التي يمكن للمساهمين الجدد استخدامها لمعرفة ما يحتاج المستخدمون إلى معرفته للمساهمة في المشروع.
إعداد بيئة التطوير
في هذا القسم، سأضيف إجراء التثبيت والتبعيات التي يلزم تثبيتها. تثبيت $project عن طريق التشغيل: تثبيت المشروع
- رمز المصدر: github.com/$project/$project
- أداة تتبُّع المشاكل: github.com/$project/$project/issues
كيفية المساهمة
كيفية الإبلاغ عن خطأ
- قبل إرسال تقرير خطأ
- كيف يمكنني إرسال تقرير أخطاء (جيد)؟
كيفية إرسال التغييرات
- بروتوكولات طلب السحب
- رد من الفريق
- سرعة الاستجابة
كيفية طلب تحسين
- قبل إرسال اقتراح التحسين
- كيف يمكنني إرسال اقتراح تحسين (جيد)؟
أوّل مساهمة لك بالرمز
- المشاكل للمبتدئين
- المساعدة المطلوبة #### طلب السحب
- عملية إنشاء طلب السحب
- تأكَّد من اجتياز جميع عمليات التحقّق من الحالة.
ماذا لو تعذّر إجراء عمليات التحقّق من الحالة؟
- اختبارات الكتابة
- نطاق الاختبار
دلائل الأسلوب
- رسائل تنفيذ Git
- النمط العادي
الدعم
يُرجى إعلامنا إذا كنت تواجه مشاكل. إذا كنت بحاجة للمساعدة، يمكنك طرح الأسئلة على قائمتنا البريدية الموجودة على العنوان: project@google-groups.com، أو دردشة IRC، أو [أدرج أي منصات اتصال أخرى يستخدمها مشروعك].
الترخيص
سيتناول هذا القسم ترخيص المشروع.
الالتزام بالوقت والتواصل:
سأخصص 45 ساعة أو أكثر في الأسبوع، ولكن في حال حدوث أي حادث سير، سأعوضك عن تلك الساعات في عطلات نهاية الأسبوع. خلال فترة علاقتي المجتمع، سأناقش وسائل التواصل وسيتم إنهاء الاجتماعات الأسبوعية والوسائل والوقت لتلك الاجتماعات مع مرشدي. سأبقي مرشدي على علم بكل جديد بشأن عملي؛ وسأشارك تفاصيل عملي عبر البريد الإلكتروني مع مرشدي. سأفضِّل استخدام برنامج TeamViewer للتواصل، نظرًا لسهولة استخدامها مع العديد من الميزات مثل مشاركة الشاشات وما إلى ذلك.