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