مشروع DIPY

تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".

ملخّص المشروع

مؤسسة مفتوحة المصدر:

DIPY

الكاتب التقني:

أريشا طارق

اسم المشروع:

إعادة تنظيم على مستوى عالٍ والتركيز على المستخدم النهائي

مدة المشروع:

مدة زمنية عادية (3 أشهر)

وصف المشروع

أنا مهندس برمجيات ولديّ خبرة في الكتابة الفنية. لدي أكثر من 4 سنوات من الخبرة في تأليف وثائق برامج عالية الجودة وأدلة المستخدم والكتيبات وأوصاف المشروعات. أقيم في إسلام أباد، باكستان (المنطقة الزمنية: التوقيت العالمي المنسق +5). أعمل حاليًا كمتدرّب في Outreachy، وسيستمر عملي حتى 18 آب (أغسطس). لقد شاركت في "موسم مستندات Google" بصفتي كاتبًا تقنيًا في مؤسسة OpenELIS Global. وكانت الوثائق الأصلية باللغة الفرنسية، بشكل محدود، وعفا عليها الزمن، لذلك أنشأت وثائق شاملة ومحدثة للمستخدمين النهائيين باللغة الإنجليزية. تم اختياري في برنامج Outreachy في مؤسسة Perl & Raku خلال الفترة من أيار (مايو) إلى آب (أغسطس) 2020 كمطوّر للجانب الخلفي لخادم Open Food Facts. بالإضافة إلى تطوير الخلفية، تتمثل إحدى المهام الرئيسية لهذا التدريب في إنشاء مستندات للوحدات والدوالّ بتنسيق POD. لقد دخلت إلى عالم البرامج المفتوحة المصدر العام الماضي عندما ساهمت في بعض المشاريع المفتوحة المصدر، ثم شاركت لاحقًا في "موسم مستندات Google". وفي هذا العام، تم اختياري في Outreachy التي تدعم التنوع في البرامج الحرة ومفتوحة المصدر. لديّ معرفة جيدة بخدمة Git لأنّ مشروع Outreachy نستضيفه على GitHub، ومنذ آذار (مارس)، أقدّم مساهمات منتظمة في Open Food Facts وMozilla Fenix. أنا أستخدم نظام التشغيل Linux منذ أكثر من 3 سنوات وأستخدم أوامر الوحدة الطرفية منذ ذلك الحين.

أدوات التوثيق واللغات التي استخدمتها هي Sphinx، وRead the المستندات، وMarkdown. لقد أعجبتني هذه الفكرة وأريد تطبيقها لأن لديّ خبرة ذات صلة وأود استخدام معرفتي ومهاراتي للمساهمة في DIPY. لديّ خبرة في مجال معالجة الصور الرقمية ورؤية الكمبيوتر والتعلم الآلي. سيساعدني ذلك في فهم التصوير العصبي بشكل أفضل والمساعدة في إنشاء مستندات. لديّ خبرة واسعة في المجال الطبي. لقد طوّرتُ موقعًا إلكترونيًا طبيًا للأطباء والمرضى والمختبرات وسائقي سيارات الإسعاف. وعملت على نظام آخر يستخدمه الأطباء والمرضى والممرضات ومساعدو المختبر والباحثون. سيساعدني ذلك في إنشاء مستندات يسهل على الجمهور فهمها.

لقد اطّلعت على مستندات DIPY ولاحظتُ العديد من العيوب فيها. هناك ثغرات متعددة في المستندات أخطّط لتحسينها. الحالة الحالية للمستندات: تنقص هذه المستندات بنية وتصميم محدّدَين وقد يكون من الصعب على المستخدمين الجدد التنقّل فيها، كما أنّها تستغرق وقتًا طويلاً قد يجد المستخدمون صعوبة في الحصول على المعلومات من الدليل يجب تحسين محتوى المستندات بصفتي مستخدمًا جديدًا، واجهت صعوبة في الوصول إلى دليل المستخدم ودليل المطوّر. يجب إعادة صياغة المستندات بطريقة تسمح بالوصول بسهولة إلى المعلومات التي يحتاجها المستخدم. تنقص المستندات الاتساق.

أخطّط لإجراء ما يلي:

تحديد بنية وقالب محدد للوثائق إعادة تشكيل الوثائق بحيث يمكن للمستخدمين التنقل بسهولة والعثور على المعلومات المطلوبة إنشاء خارطة طريق أو قائمة ببنود العمل لإشراك المجتمع في أعمال التوثيق الإضافية تحديد نماذج لدليل المستخدم ودليل المطوّر تحديد نماذج لدليل المستخدم إعادة كتابة دليل المستخدم وإعادة هيكلته وتحديث دليل المستخدم ودليل التطوير ودليل المساهمة (الذي يمكن أن يساعد في تحسين الواجهة النصية وتحفيز المستخدمين الجدد)

دليل المستخدم:

بالنسبة إلى دليل المستخدم، سأركّز على استخدام لغة بسيطة وواضحة لمساعدة المستخدمين على فهم حتى أكثر الأنظمة تعقيدًا. لتوفير تجربة أفضل للمستخدم، يجب تجنُّب المصطلحات والاختصارات والمعلومات الداخلية الأخرى التي قد لا يعرفها المستخدم الجديد. سأركّز أيضًا على استخدام المحتوى المرئي، بما في ذلك الصور ولقطات الشاشة المُشارَك عليها تعليقات توضيحية والرسومات والفيديوهات التي توضّح للمستخدم بسرعة طريقة عمل النظام. تحتاج المستندات الجيدة إلى تسلسل هرمي للعناوين والعناوين الفرعية التي تتيح للمستخدم معرفة ما سيعرضه كل قسم. ويجب أن يتبع هذا التسلسل الهرمي تدفقًا منطقيًا يساعد المستخدم على تعلم استخدام النظام بالطريقة الأكثر فائدة. من الأهداف الرئيسية لهذا المشروع إنشاء محتوى سهل الاستخدام. يجب أن تلتزم جميع المستندات والأدلة بنمط متّسق. يجب استخدام خطوط متّسقة وألوان تكميلية في جميع المستندات المتعددة. سأحرص على إتاحة المزيد من موارد المؤسسة للمستخدمين حول كيفية تحقيق النجاح باستخدام النظام.

دليل المطوّر:

يتضمّن دليل المطوّر إرشادات ومواد مرجعية مفصّلة لمساعدة المطوّر في إنشاء مساهمات في رمز مصدر DIPY. ويحاول توضيح الخيارات المختلفة المتاحة لك، حتى تتمكّن من استخدام النهج المناسب، استنادًا إلى ما تريد تحقيقه. يحتاج دليل التطوير إلى إعادة التصميم وإعادة التنظيم. سأعيد كتابة محتوى دليل المطوّر. سيتم تضمين دليل المساهمة ودليل الأنماط وقواعد الترميز ودليل المستندات وتركيب بيئة التطوير وتصحيح الأخطاء ودليل الاختبار والعناصر ذات الصلة، وسيتم إتاحة هذه العناصر للمطوّرين بسهولة. عندما يندفع المساهمون الجُدد إلى مشروعك لتقديم أول مساهمة لهم في مشروع مفتوح المصدر، يعتمدون على إرشادات المساهمة كدليل لهم. وبالتالي، ستكون الإرشادات سهلة القراءة وشاملة وواضحة. أدلة المساهمة هي مستندات مفيدة توضّح كيفية مساهمة المستخدمين في المشروع المفتوح المصدر. يجب أن تكون المساهمة في المشروع سهلة وشفافة قدر الإمكان للمستخدمين، سواء كان ذلك: إرسال إصلاح الإبلاغ عن خطأ الاشتراك في الصيانة مناقشة الحالة الحالية للكود اقتراح ميزات جديدة

TEMPLATE

هذا هو أحد النماذج التي يمكن استخدامها في دليل المساهمات. ويمكن تعديله وإضافة أقسام إليه أو إزالتها وفقًا لمتطلبات المستند.

المساهمة في DIPY

• رسالة ترحيب

TOC

مدوّنة السلوك

• معاييرنا
• أمثلة على السلوك الذي يساهم في خلق بيئة إيجابية
• أمثلة على السلوك غير المقبول للمشاركين
• مسؤولياتنا
• مسؤوليات مشرفي المشاريع
• النطاق

نطاق مدوّنة السلوك

ما هي المعلومات التي أحتاج إلى معرفتها لمساعدتك؟

إذا أردت المساهمة في المشروع من خلال إرسال رمز برمجي، يُرجى استخدام [إدراج قائمة بلغات البرمجة أو أطر العمل أو الأدوات التي يستخدمها مشروعك]. إذا لم تكن مستعدًا بعد لمشاركة رمز، لا داعي للقلق. يمكنك أيضًا الاطّلاع على مشاكل المستندات [رابط يؤدي إلى تصنيف أو علامة المستندات في أداة تتبُّع المشاكل] أو مشاكل التصميم التي واجهناها [رابط يؤدي إلى تصنيف أو علامة التصميم في أداة تتبُّع المشاكل إذا كان مشروعك يتتبّع مشاكل التصميم]. إذا كنت مهتمًا بتقديم مساهمة في الرموز البرمجية وتريد الاطّلاع على مزيد من المعلومات عن التقنيات التي نستخدمها، اطّلِع على القائمة أدناه. قم بتضمين قائمة نقطية بالموارد (البرامج التعليمية ومقاطع الفيديو والكتب) التي يمكن للمساهمين الجدد استخدامها لمعرفة ما يحتاج المستخدمون إلى معرفته للمساهمة في المشروع.

إعداد بيئة التطوير

في هذا القسم، سأضيف إجراء التثبيت والتبعيات التي يجب تثبيتها. تثبيت $project من خلال تشغيل: install project

• رمز المصدر: github.com/$project/$project
• أداة تتبُّع المشاكل: github.com/$project/$project/issues

كيفية المساهمة

كيفية الإبلاغ عن خلل

• قبل إرسال تقرير خطأ
• كيف يمكنني إرسال تقرير (جيد) عن الخطأ؟

كيفية إرسال التغييرات

• بروتوكولات طلبات سحب الرمز البرمجي
• رد من الفريق
• سرعة الاستجابة

كيفية طلب تحسين

• قبل إرسال اقتراح تحسين
• كيف يمكنني إرسال اقتراح تحسين (جيد)؟

مساهمتك الأولى باستخدام الرمز

• مشاكل المبتدئين
• المشاكل التي تستدعي المساعدة #### طلب سحب
• عملية إنشاء طلب سحب
• تأكَّد من اجتياز جميع عمليات التحقّق من الحالة.

ماذا لو تعذّر إكمال عمليات التحقّق من الحالة؟

• اختبارات الكتابة
• تغطية الاختبار

أدلة الأنماط

• رسائل تنفيذ Git
• النمط العادي

الدعم

إذا واجهت مشاكل، يُرجى إعلامنا بها. إذا كنت بحاجة إلى مساعدة، يمكنك طرح الأسئلة على قائمتنا البريدية على العنوان: [e-mail] أو محادثة IRC أو [إدراج أي منصات تواصل أخرى يستخدمها مشروعك].

الترخيص

سيوضح هذا القسم ترخيص المشروع.

الالتزام بالوقت والتواصل:

سأعمل أكثر من 45 ساعة في الأسبوع، ولكن في حال حدوث أي حادث، سأعوض تلك الساعات في عطلات نهاية الأسبوع. خلال فترة الاندماج في المنتدى، سأناقش وسائل التواصل وسأحدّد مع المرشد الاجتماعات الأسبوعية ووسائلها ووقتها. سأطلع المرشد على آخر الأخبار حول عملي، وسأشارك تفاصيل عملي معه عبر البريد الإلكتروني. سأفضّل استخدام TeamViewer للتواصل، لأنّه سهل الاستخدام ويحتوي على الكثير من الميزات، مثل مشاركة الشاشات وما إلى ذلك.