تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخّص المشروع
- مؤسسة مفتوحة المصدر:
- INCF
- الكاتب الفني:
- hq
- اسم المشروع:
- مستندات تدريب على استخدام أداة LORIS لعلوم الأعصاب القابلة للتكرار والمفتوحة المصدر
- مدة المشروع:
- الحمل لمدة طويلة (5 أشهر)
وصف المشروع
1- ملخص
نظام "البحث والتصوير على الإنترنت على المدى الطويل" (LORIS) هو منصة لإدارة المشاريع على الويب لأبحاث التصوير العصبي، وتدعم العديد من مبادرات "العلوم المفتوحة". يلعب التوثيق دورًا مهمًا في نظام LORIS. على وجه التحديد، تساعد المستندات مستخدمي LORIS ومطوّريه على فهم تفاصيل البرنامج حتى يتمكّنوا من استخدام المنصة بشكل أفضل أو المساهمة في تطوير البرنامج. وفي الوقت نفسه، يجب أيضًا تعديل مستندات LORIS. يهدف هذا المشروع إلى مساعدة LORIS في تحسين مستنداتها.
2- الحالة الحالية
يستخدم LORIS حاليًا موقع GitHub Wiki وقراءة المستندات وموقع LORIS.ca لاستضافة جميع الوثائق. على وجه التحديد، يستضيف LORIS GitHub Wiki أكبر قدر من مستندات LORIS، ويتم استضافة برامج LORIS التعليمية والعروض التقديمية وأدلة المستخدمين والإجراءات التفصيلية الإضافية في مجموعة متنوعة من المنصات . توفّر مستندات LORIS الحالية أدلة للمطوّرين ومستخدمي LORIS، ولكن يمكن أن تستفيد من المزيد من التطوير والتنظيم، لا سيما في ما يتعلّق بالتعديلات على المستندات والتحسينات في التفاصيل الفنية.
3- مزايا المنتدى
من خلال تحسين مستندات تدريب LORIS للعلوم العصبية القابلة للتكرار والمفتوحة، سيستفيد الباحثون والمطوّرون من أداة أكثر سهولة في الاستخدام لتحسين جمع البيانات في دراساتهم. على وجه التحديد، قد يُجري المشروع تعديلات على مستندات تثبيت/إعداد LORIS ويُحسنها، بالإضافة إلى مواد المستخدم النهائي التي تقدّم تدريبًا للمستخدمين الجدد. بالإضافة إلى ذلك، سيهدف المشروع إلى المساعدة في نقل الوثائق وتعديلها من موسوعة LORIS على GitHub إلى Read the Docs. وفي الوقت نفسه، قد يقدّم المشروع مخطّطًا بيانيًا لقاعدة البيانات لشرح علاقات البيانات وتحسين العرض المرئي للبنية المعمارية. أخيرًا، سيعمل هذا المشروع على تعديل المحتوى الذي يعرّف المستخدمين على LORIS وسياق العلوم المفتوحة وحالات الاستخدام، وتحسينه.
4- نقاط القوة الشخصية للمشروع
خلال السنوات القليلة الماضية، شاركت في العديد من المشاريع الفنية التي اكتسبت من خلالها خبرة قوية في الكتابة الفنية. على وجه التحديد، كنت مسؤولاً عن كتابة المستندات في عدة مشاريع جماعية سابقة وأعتقد أنّ لديّ خبرة كافية في استخدام أدوات الكتابة الفنية، مثل Read the Docs وSphinx وMkdocs وMarkdown وLaTeX وما إلى ذلك. وفي الوقت نفسه، حسّنت تجربتي التدريسية السابقة في دورات STEM مهاراتي في التواصل الفني. إنّ مستندات التدريب في LORIS لمشاريع العلوم العصبية القابلة للتكرار والمفتوحة مع INCF ستكون فرصة رائعة بالنسبة إليّ لتطبيق تقنيات الكتابة الفنية على LORIS. بالإضافة إلى ذلك، أنا مهتم جدًا بمجال التصوير العصبي، وكنت أحاول العثور على فرص لتطبيق معرفتي الفنية في هذا المجال. لقد كانت مستندات تدريب LORIS الخاصة بالمشاريع المفتوحة في مجال علم الأعصاب التي يمكن إعادة إنتاجها باستخدام INCF تجربة قيّمة بالنسبة لي.
5- المُخرَجات النهائية
- نقل مستندات LORIS الحالية وتعديلها
- مراجعة وثائق التثبيت/الإعداد لـ LORIS وتحديثها وتحسينها، وسد الثغرات في مواد المستخدمين النهائيين التي توفر التدريب للمستخدمين الجدد
- المساعدة في إنشاء مخطّط بياني لقاعدة بيانات لشرح علاقات البيانات (مثل الموضوع والزيارة الدراسية) وتحسين العرض المرئي للتصميم
- المساعدة في تعديل وتحسين مستندات LORIS API
- المساعدة في تعديل المحتوى وتحسينه الذي يعرّف المستخدمين على LORIS وسياق العلوم المفتوحة وحالات الاستخدام التي تتضمّن تنسيقات وسائط متعددة
6- المخطط الزمني
"الربط المجتمعي" (17 أغسطس - 13 سبتمبر) أ) التعرف الكامل على برنامج LORIS وسير عمل الفريق. ب) مراجعة وتحديث وتحسين وثائق تثبيت/إعداد LORIS.
الأسبوع 1 (من 14 إلى 20 أيلول/سبتمبر) تعديل مستندات LORIS ونقلها من موسوعة GitHub إلى Read the Docs
الأسبوع 2 (من 21 إلى 27 أيلول/سبتمبر) أ) مراجعة مواد المستخدم النهائي الحالية في LORIS (ب) البدء في سد الفجوات في مواد المستخدم النهائي في LORIS من خلال تقديم تدريب للمستخدمين الجدد استنادًا إلى المستندات الحالية
الأسبوع 3 (28 سبتمبر - 4 أكتوبر) إنهاء الفجوات في مواد مستخدمي LORIS لتقديم تدريب للمستخدمين الجدد.
الأسبوع 4 (من 5 تشرين الأول (أكتوبر) إلى 11 تشرين الأول (أكتوبر)): أ) فهم بنية قاعدة بيانات LORIS الحالية ب) بدء تنفيذ مخطّط قاعدة البيانات لمنصّة LORIS
الأسبوع 5 (من 12 تشرين الأول (أكتوبر) إلى 18 تشرين الأول (أكتوبر)) أ) إكمال مهمة إنشاء مخطّط بياني لقاعدة بيانات LORIS ب) مراجعة واجهة برمجة التطبيقات LORIS API الحالية والبدء في المساعدة في تحسين مستندات واجهة برمجة التطبيقات
الأسبوع 6 (من 19 تشرين الأول (أكتوبر) إلى 25 تشرين الأول (أكتوبر)): مواصلة العمل على تحسين مستندات LORIS API
الأسبوع 7 (26 تشرين الأول (أكتوبر) - 1 تشرين الثاني (نوفمبر)) إنهاء التحسين في مستندات واجهة برمجة تطبيقات LORIS
الأسبوع 8 (من 2 تشرين الثاني (نوفمبر) إلى 8 تشرين الثاني (نوفمبر)): راجِع المحتوى الحالي الذي يعرّف المستخدمين على LORIS وابدأ في تعديل سياق العلوم المفتوحة وتحسينه.
الأسبوع 9 (من 9 إلى 15 تشرين الثاني (نوفمبر)): إنهاء التعديلات والتحسينات على سياق العلوم المفتوحة في محتوى تعريف المستخدمين على LORIS
الأسبوع 10 (16 نوفمبر - 22 نوفمبر) ساعِد في تحديث وتحسين جزء من حالات الاستخدام في المحتوى الذي يعرّف الأشخاص على LORIS.
الأسبوع 11 (من 23 إلى 29 تشرين الثاني (نوفمبر)): إنهاء تعديل جميع حالات الاستخدام وتحسينها في المحتوى الذي يعرّف المستخدمين على LORIS
إنهاء المشروع (من 30 تشرين الثاني (نوفمبر) إلى 5 كانون الأول (ديسمبر)) أ) تنظيف جميع المساهمات في المستندات التي أنشأتها ب) دمج جميع طلبات الجذب التي تم إنشاؤها على GitHub وإغلاق جميع المشاكل التي أنشأتها ج) إنهاء تقرير المشروع النهائي وإرساله إلى Google
7- المُخرَجات النهائية المستقبلية
بعد انتهاء "موسم مستندات Google" لعام 2020، أود مواصلة مساهماتي في إعداد مستندات LORIS. على وجه التحديد، أريد مناقشة إمكانية مواصلة تعديل المستندات وإنشاءها للإصدارات الجديدة مع مطوّري LORIS. وعلاوة على ذلك، أود أن أستغرق بعض الوقت لمراجعة المستندات التي أنشأتها خلال مشروع Google الخاص بموسم المستندات والتحقق مما إذا كان هناك مجال أكبر للتحسين. وأخيرًا، نظرًا لأن لديّ خلفية هندسية ذات صلة، فأنا منفتح على المساهمة في جوانب أخرى من برنامج LORIS في المستقبل، مثل تطوير البرمجيات.