تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخّص المشروع
- مؤسسة مفتوحة المصدر:
- ESLint
- الكاتب الفني:
- خاوار
- اسم المشروع:
- إعادة تنظيم/إعادة كتابة مستندات الضبط
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
ملخص
الهدف من هذا المشروع هو إعادة هيكلة وثائق التكوين لـ ESLint وإنشاء بنية معلومات فعالة. سيؤدي ذلك إلى تسهيل التنقّل وتحسين سهولة استخدام المستندات وفائدتها.
ملخص المشروع توفر وثائق تهيئة ESLint (https://eslint.org/docs/user-guide/configring)، في الحالة الحالية، الكثير من المعلومات في صفحة واحدة. على الرغم من توفُّر العناوين والعناوين الفرعية والفقرات المناسبة على الصفحة، يمكن أن تصبح المستندات مربكة. لا تتوفّر طريقة للانتقال إلى قسم معيّن من الصفحة، ما يسبب الإزعاج للمستخدم المهتم بقسم معيّن. يمكن أيضًا أن تضيع المعلومات، بسبب هذا النقص في التنظيم، وتفشل في تحقيق غرضها وتطلب من المستخدمين بذل جهد إضافي.
ومع ذلك، يمكن حلّ هذه المشاكل من خلال سلسلة من الخطوات الدقيقة. نقترح إجراء تدقيق في المحتوى كخطوة أولى في عملية إعادة التنظيم هذه. لن تساعد عملية تدقيق المحتوى في تحديد المشاكل في عرض المعلومات فحسب، بل ستسلّط الضوء أيضًا على أوجه القصور في المحتوى نفسه (مثل المعلومات القديمة أو غير المكتملة). أخطط بعد ذلك لإنشاء بنية المعلومات (IA) للكشف عن شبكة المعرفة. سيتيح لنا ذلك تجميع المعلومات حسب مواضيع مختلفة والعثور على روابط بين مواضيع مختلفة ذات صلة وثيقة. وسيتم بعد ذلك استخدام الإحصاءات التي تم الحصول عليها من خلال هاتين الطريقتَين لتقسيم المستندات التي تتألف من صفحة واحدة إلى صفحات متعددة. يمكن بعد ذلك ربط الحزمة بأكملها والرجوع إليها التداخل في Markdown. نتيجةً لذلك، سيكون هناك إصدار من مستندات الضبط أكثر تنظيمًا، ويكون من الأسهل التنقل فيه والتعرّف عليه.
الدافع على الرغم من أنّني أستخدم البرامج مفتوحة المصدر منذ فترة طويلة، إلا أنّني لم أتعرّف على هذا المصطلح إلا مؤخرًا، تمامًا مثل معرفتي ببرامج Linting. عندما بدأت في تعلم لغة Python (من خلال edX)، تساءلت كيف يمكن للأخطاء الصغيرة أن تفسد التعليمات البرمجية بأكملها. لقد فكّرت في أنّه من الجيد اختبار الرموز البرمجية بطريقة ما وتحديد الأخطاء، ثم تعرّفت على مصطلح "فحص الأخطاء". لم أستخدم برامج فحص الأخطاء بشكل مناسب حتى الآن، ولكنني متأكّد من أنّها ستسهّل حياتي كثيرًا في الأيام المقبلة.
وبفضل خبرتي في الهندسة الكهربائية وخبرتي في البرمجة، يمكنني فهم مشاكل الترميز ومتطلبات المبرمجين بطريقة أفضل. بالإضافة إلى ذلك، تجعلني شهادتي العليا في مجال الاتصالات الفنية والمهنية من المدافعين عن المستخدمين، وأسعى إلى تسهيل حياتهم. ستكون مهاراتي وخبرتي مزيجًا جيدًا لهذا المشروع، ما سيضيف قيمة إلى مستندات ESLint.
الأهداف إن الهدف الرئيسي لهذا المشروع هو ضمان سهولة فهم الوثائق الموجودة على صفحة تهيئة ESLint ولا تربك المستخدمين. من المهم لنجاح المشروع أن يكون التنقّل في المحتوى سهلًا وخالٍ من أي تعقيدات. في ما يلي الأهداف المهمة للمشروع. - إجراء تدقيق شامل للمحتوى - إنشاء بنية معلومات لفهم تدفّق المعلومات - تحسين بنية المعلومات لإعادة تنظيم المستندات - تحديد الروابط والإحالات بين الأقسام المختلفة من المحتوى - إعادة كتابة/تعديل أجزاء من المستندات، إذا لزم الأمر لتلبية متطلبات إعادة الضبط
- التأكد من أن المحتوى مرن وقابل لإعادة الاستخدام
وصف المشروع يعدّ ضبط ESLint ميزة مهمة تجعل ESLint قابلاً للتخصيص. من المؤكد أنّ المستخدمين المهتمين بالضبط سيهتمون بجانب أو جانبَين في وقت معيّن. لذلك، من المهم توجيه المستخدم إلى الموضوع الذي يهمّه، ما يقدّم له الحلّ بطريقة فعّالة. تحتوي الحالة الحالية لمستندات ضبط ESLint على الكثير من المعلومات المفيدة، ولكنّها منظمة بطريقة قد تجعل المستخدمين يشعرون بالارتباك والإحباط والضياع. على سبيل المثال، إذا كان أحد المستخدمين مهتمًا بالتعرّف على استخدام المكوّنات الإضافية التابعة لجهات خارجية في ESLint، عليه الانتقال للأسفل من خلال المناقشة حول تحديد المعالج والبيئات والمتغيّرات الشاملة. إنّ هذه العملية بأكملها متعبة للمستخدمين ويمكن أن تدفعهم إلى الابتعاد عن الموقع الإلكتروني. وبالمثل، إذا كان المستخدم في مكان ما في منتصف الصفحة وأراد الانتقال إلى قسم معيّن أو الاطّلاع على مواضيع مشابهة فقط، لن تكون هذه مهمة سهلة بالنسبة إليه، لأنّه لا يتم تقديم أي مساعدة من هذا النوع للمستخدمين. تتطلّب هذه المشاكل الانتباه الفوري لأنّ جودة أي مستندات، بغض النظر عن مدى جودة صياغتها، تعتمد على مدى فائدتها. نقترح حلولاً لهذه المشاكل وغيرها من المشاكل ذات الصلة في المناقشة التالية.
تدقيق المحتوى: الخطوة الأولى في عملية إعادة تنظيم مستندات الضبط هي إجراء تدقيق شامل للمحتوى. سيهدف هذا الفحص إلى تحديد بعض المشاكل الرئيسية، مثل المحتوى القديم أو المكرّر أو غير المتوفّر، وما إلى ذلك. وسيتمّ مشاركة جدول بيانات فحص المحتوى الذي تم إنشاؤه نتيجةً لذلك مع فِرق الإدارة والمستندات للحصول على ملاحظاتهم. سيساعد هذا في الخروج باستراتيجية جديدة لهيكلة الوثائق وتقديمها.
إنشاء بنية المعلومات لفهم شبكة المعرفة أو تدفق المعلومات في وثائق التهيئة، قد يكون إنشاء بنية المعلومات (IA) أمرًا ذا قيمة. ستشكّل نتائج تدقيق المحتوى أساسًا جيدًا لفهم وتيرة عرض المعلومات وتطويرها. بعد ذلك، سيتم إنشاء نسخة محسّنة من تحليل سير العمل لتنظيم المستندات وعرضها بطريقة أفضل. لن تؤدي تقنية الذكاء الاصطناعي المحسّنة هذه إلى إعادة تنظيم المحتوى الحالي فحسب، بل ستحدد أيضًا الروابط والتفرّعات بين الأقسام المختلفة من المستندات، ما يؤدي إلى إنشاء شبكة فعّالة. على سبيل المثال، يمكن أن يتضمّن المحتوى حول "ضبط القواعد" رابطًا يؤدي إلى "إيقاف القواعد باستخدام التعليقات المضمّنة". ويمكن أيضًا تحديد روابط أخرى مماثلة، ما يؤدي إلى إنشاء علاقات بين الأقسام المختلفة من المستندات.
جدول المحتويات: ستوفّر لك عملية تدقيق المحتوى وتحليل المحتوى معلومات كافية لإنشاء جدول محتويات مفصّل يتضمّن روابط تؤدي إلى أقسام وأقسام فرعية محدّدة من المستندات. يمكن أن يؤدي إنشاء ملفات منفصلة لكل قسم وإضافة مراجع مناسبة إلى الأقسام الأخرى إلى إضافة قيمة إلى المجموعة الكاملة من المستندات. يمكن إنشاء جدول محتويات للمستخدمين الذين يصلون إلى مستندات الضبط، ما يساعدهم في تنقّلهم على الموقع الإلكتروني. يمكن أن يتضمّن جدول المحتويات جميع العناوين ذات المستوى الأول والثاني ليكون موجزًا وشاملًا. على سبيل المثال، إحدى هذه الممارسات هي تلك التي تستخدمها أداة Prettier (https://prettier.io/docs/en/index.html) لتنظيم المستندات.
سيتم إنشاء جميع المستندات باستخدام Markdown للحفاظ على البساطة والتنظيم الجيد. وسنحرص على أن تكون هذه المستندات قابلة لإعادة الاستخدام، لأنّها قد تتغيّر وتتطوّر في المستقبل.
الأدوات المستخدَمة في ما يلي بعض الأدوات المهمة التي يمكن أن تكون مفيدة أثناء العمل على المشروع: - Draw.io لإنشاء الرسوم التوضيحية لتحليل التفاعلات بين المستخدمين حسب الحاجة - Atom (أو محرِّر مشابه) لكتابة المستندات وتعديلها بتنسيق Markdown
- GitHub لضمان التحكّم في إصدارات المستندات
المعالم الرئيسية بدءًا من تقديم الاقتراح إلى إكمال المشروع، ستضمن المعالم الرئيسية المؤقتة التالية اكتمال المشروع في الوقت المحدد، والحفاظ على التدفق الصحيح في العملية.
من 10 تموز (يوليو) 2020 إلى 16 آب (أغسطس) 2020: مراجعة الاقتراحات واختيارها سأراجع مستندات ESLint وأطوّر المهارات اللازمة لإكمال المشروع (مثل كتابة Markdown والتعاون على GitHub). سأساهم أيضًا في إنشاء المستندات من خلال GitHub والتفاعل مع مستخدمين آخرين لفهم المستندات بشكل أفضل.
من 17 آب (أغسطس) 2020 إلى 13 أيلول (سبتمبر) 2020: فترة التفاعل مع المنتدى خلال فترة التفاعل مع المنتدى، سأُجري تحسينات على مقترحي وفقًا للمناقشات مع المرشدين والفرق المعنية. سأُجري أيضًا تعديلات على الأهداف والمحطّات الرئيسية إذا لزم الأمر. بالإضافة إلى ذلك، سأحرص على إنشاء قائمة مختصرة للأدوات التي سيتم استخدامها بعد ذلك للعمل في المشروع.
من 14 أيلول (سبتمبر) 2020 إلى 19 أيلول (سبتمبر) 2020: تدقيق المحتوى لبدء المشروع، سأجري تدقيقًا شاملاً للمحتوى في وثائق الضبط. والهدف من ذلك هو إبراز المشاكل المتعلقة بالمحتوى وطريقة عرضه.
الفترة من 20 أيلول (سبتمبر) 2020 إلى 25 أيلول (سبتمبر) 2020: بنية المعلومات (IA) بعد تدقيق المحتوى، سأنشئ بنية المعلومات لمستندات الضبط. سأركّز على تقديم شبكة المعرفة بطريقة مفهومة. سيساعد ذلك بعد ذلك في إجراء تحسينات على تدفق المعلومات.
الفترة من 26 أيلول (سبتمبر) 2020 إلى 30 أيلول (سبتمبر) 2020: الروابط والمراجع سأحلّل تحليل واجهة المستخدم (IA) خلال هذه المرحلة لتحديد الروابط والمراجع بين الأقسام المختلفة من المستندات. سأنشئ أيضًا تسلسلاً هرميًا لجميع الأقسام، ما يؤدي إلى تحسين بنية المعلومات في هذه العملية.
في الفترة من 1 تشرين الأول (أكتوبر) 2020 إلى 3 تشرين الأول (أكتوبر) 2020: الخريطة النهائية بالاستعانة بالإحصاءات المكتسبة من خلال تدقيق المحتوى وبنية المعلومات، سأنشئ خريطة نهائية ليتم تنفيذها في مستندات الإعدادات المُعاد تنظيمها. ستحتوي هذه الخريطة الشاملة على جدول محتويات، وتسلسلاً هرميًا للمواضيع، وقائمة من الروابط والمراجع المشتركة بين أقسام الوثائق.
من 4 تشرين الأول (أكتوبر) 2020 إلى 5 تشرين الأول (أكتوبر) 2020: المناقشة في هذه المرحلة، قبل تعديل الوثائق، سأعرض النتائج التي توصلت إليها وأخطط للمرشدين والفِرق المعنية. ستساعدنا ملاحظاتهم في تحسين الخطة وإجراء التعديلات عند الضرورة.
من 6 تشرين الأول (أكتوبر) 2020 إلى 20 تشرين الأول (أكتوبر) 2020: إعادة الكتابة والتعديل خلال هذه الفترة، سأعدِّل أقسام المستندات التي تتطلّب العمل وأعدّلها. قد تتم إعادة كتابة بعض أقسام وثائق الضبط أو إضافة بعض العناصر الجديدة إليها. سينصبّ التركيز في هذه المرحلة على التأكّد من أنّ المستندات دقيقة ومحدّثة ومرنة وقابلة لإعادة الاستخدام.
من 21 تشرين الأول (أكتوبر) 2020 إلى 25 تشرين الأول (أكتوبر) 2020: التصحيحات والروابط في هذه المرحلة، سأراجع عملي للتخلص من الأخطاء النحوية والتركيبية، وسأعيد التحقّق من عملي للتأكّد من دقته. سأضيف أيضًا روابط وإشارات مرجعية بين الأقسام، وفقًا لتحليل الاحتياجات، لضمان أن تتّبع المستندات خريطة المعرفة التي تم وضعها سابقًا.
26 أكتوبر 2020 - 31 أكتوبر 2020: النسخة النهائية للإرسال سأربط جميع ملفات Markdown، وأقوم بإنشاء جدول محتويات، وأشارك المسودات مع المرشدين. سيُعدّ هذا الإجراء بمثابة إرسال المسودة الأولى، في شكل حزمة كاملة.
من 1 تشرين الثاني (نوفمبر) 2020 إلى 5 تشرين الثاني (نوفمبر) 2020: المراجعة الأولى خلال هذه الأيام الخمسة، سأناقش المسودة الأولى مع خبراء الإرشاد. سأحصل على ملاحظاتهم وسأناقش أفكاري معهم لإنشاء قائمة بالتعديلات التي يجب إجراؤها.
من 6 تشرين الثاني (نوفمبر) 2020 إلى 12 تشرين الثاني (نوفمبر) 2020: التعديلات الأولى بمساعدة ملاحظات المرشدين، سأعدّل المسودة الأولى من المستندات. ستعتمد التعديلات الفعلية على طبيعة التعليقات والملاحظات، ولكن ستكون أهداف إعادة الاستخدام والدقة والمرونة هي أساس مرحلة التعديل.
13 تشرين الثاني (نوفمبر) 2020 - 15 تشرين الثاني (نوفمبر) 2020: المراجعة الثانية بعد الانتهاء من التعديلات الأولية، سأناقش مستوى التقدّم مع المرشدين والفرق المعنية مرة أخرى. وستركّز هذه المناقشات على التعديلات التي تم إجراؤها على النسخة الأولى، كما تسلط الضوء على أي مشاكل أخرى ربما حدثت أثناء عملية التعديل.
من 16 تشرين الثاني (نوفمبر) 2020 إلى 19 تشرين الثاني (نوفمبر) 2020: التعديلات الثانية سنخصّ بعد ذلك فترةً مدتها أربعة أيام لتعديل المستند. وسيتم مناقشة النُسخ التي يتم إنشاؤها نتيجةً لذلك مع المرشدين لمنحهم الشكل النهائي. عند الانتهاء من هذه المرحلة، ستكون المستندات في شكلها النهائي، وستكون جاهزة للتحميل إلى الموقع الإلكتروني ومستودع GitHub.
من 20 تشرين الثاني (نوفمبر) 2020 إلى 23 تشرين الثاني (نوفمبر) 2020: التحميل على الموقع الإلكتروني بعد إجراء جميع التعديلات اللازمة، سيتم تحميل المستندات على الموقع الإلكتروني. سيتم التعامل مع أي مشاكل تواجهك في هذه العملية وفقًا لذلك، لأنّه سيظل لدينا بضعة أيام للعمل على المستندات.
الفترة من 24 تشرين الثاني (نوفمبر) 2020 إلى 28 تشرين الثاني (نوفمبر) 2020: تقرير المشروع: سيتم إنشاء تقرير تفصيلي عن المشروع خلال هذه الفترة التي تبلغ خمسة أيام. ستشكل الأهداف والمصاعب والمشكلات والحلول المقدمة جزءًا من تقرير المشروع. ستتم مشاركة التقرير مع المرشدين للحصول على ملاحظاتهم.
من 29 تشرين الثاني (نوفمبر) 2020 إلى 30 تشرين الثاني (نوفمبر) 2020: تاريخ الإرسال النهائي سيتم إرسال المشروع إلى المرشدين مع جميع الملفات وتقرير المشروع. ستتم مراجعة المشروع بأكمله من خلال اجتماع/مناقشة مع المرشدين والفِرق المعنية.
وخلال المشروع، سأواصل استشارة الخبراء للحصول على ملاحظاتهم القيّمة. يمكن تغيير كل هذه المعالم استنادًا إلى المناقشات مع المرشدين خلال فترة التفاعل مع المنتدى ومراجعة الاقتراحات.
لمحة عني لديّ درجة جامعية في الهندسة الكهربائية ودرجة دراسات عليا في الاتصالات الفنية والمهنية من جامعة ولاية كارولينا الشمالية. لديّ خبرة في مجالات الكتابة والتعديل الفني والمهني، وإدارة المحتوى والتواصل، ودراسات قابلية الاستخدام على الويب والأجهزة الجوّالة، وتصميم التعليمات. عملت كمحرر فرعي لجهة نشر على الإنترنت (Global Village Space) ومتدرب في مجال الاتصالات لدى "ديوك فورج" بجامعة ديوك. فضلاً عن ذلك، لدي أيضًا اهتمام بالكتابة الإبداعية.