تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول ضمن "موسم المستندات" من Google.
ملخص المشروع
- مؤسسة البرامج المفتوحة المصدر:
- ESLint
- الكاتب الفني:
- خوار
- اسم المشروع:
- إعادة تنظيم/إعادة كتابة مستندات الإعدادات
- طول المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
تجريدي
الهدف من هذا المشروع هو إعادة هيكلة وثائق تكوين ESLint وإنشاء بنية معلومات فعالة. سيؤدي ذلك إلى تسهيل التنقل وكذلك تحسين سهولة استخدام الوثائق وفائدتها.
ملخّص المشروع في الحالة الحالية، توفّر وثائق إعداد ESLint (https://eslint.org/docs/user-guide/configring) الكثير من المعلومات في صفحة واحدة. على الرغم من وجود عناوين وعناوين فرعية وفقرات مناسبة على الصفحة، يمكن أن تكون الوثائق مربكة. لا تتوفّر طريقة للانتقال إلى قسم معيّن من الصفحة يزعج المستخدم المهتم بقسم معيّن في الصفحة. يمكن أيضًا أن تضيع المعلومات، بسبب نقص التنظيم، وتفشل في تحقيق الغرض منها وتطلب من المستخدمين بذل جهد إضافي.
ومع ذلك، يمكن حل هذه المشاكل باتّباع سلسلة من الخطوات الدقيقة. أقترح إجراء تدقيق للمحتوى كخطوة أولى في عملية إعادة التنظيم هذه. لن يساعدك تدقيق المحتوى في تحديد المشاكل في عرض المعلومات فحسب، بل سيوضح أيضًا أوجه القصور في المحتوى نفسه (على سبيل المثال، المعلومات القديمة أو غير المكتملة). أخطط بعد ذلك لإنشاء بنية المعلومات (IA) للكشف عن شبكة المعرفة. وسيمكّننا ذلك من تجميع المعلومات وفقًا لمواضيع مختلفة والعثور على روابط بين مواضيع متنوّعة وثيقة الصلة. سيتم بعد ذلك استخدام الرؤى المكتسبة من خلال هاتين الممارستين لتقسيم وثائق الصفحة الواحدة إلى صفحات متعددة. يمكن بعد ذلك ربط الحزمة بأكملها والإشارة إليها في Markdown. ونتيجةً لذلك، ستتوفّر نسخة منظمة بشكل أفضل من مستندات الضبط، يسهل التنقّل فيها وفهمها.
الدافع على الرغم من أنني أستخدم برنامجًا مفتوح المصدر منذ فترة طويلة، فإن معرفتي بالمصطلح جديد إلى حد ما، تشبه معرفتي ببرامج Linting. عندما بدأت تعلم لغة Python (من خلال edX)، كنت أتساءل كيف يمكن للأخطاء البسيطة أن تُفسد الرمز بأكمله. ظننتُ أنّه من الجيد اختبار الرموز بطريقة ما، وتحديد الأخطاء، ثم تعلّمت عن مصطلح "الكشف عن الوبر". لم أستخدم حتى الآن برنامجًا مؤكَّدًا، ولكنني على يقين من أنّ هذه البرامج ستجعل حياتي أسهل كثيرًا في الأيام القادمة.
يمكنني فهم مشكلات الترميز ومتطلبات المبرمجين بطريقة أفضل بفضل خلفيتي في الهندسة الكهربائية وخبرة في البرمجة. بالإضافة إلى ذلك، فإن درجة الدراسات العليا في الاتصالات الفنية والمهنية تجعلني مدافعًا عن المستخدمين، في محاولة لجعل الحياة أسهل للناس. ستشكّل مهاراتي وخبراتي مزيجًا جيدًا لهذا المشروع، ما يضيف قيمة إلى وثائق ESLint.
الأهداف الهدف الرئيسي لهذا المشروع هو التأكد من أن الوثائق الموجودة في صفحة إعداد ESLint سهلة الفهم ولا تربك المستخدمين. من المهم لنجاح المشروع أن يكون التنقل عبر المحتوى سهلاً وخاليًا من جميع التعقيدات. الأهداف المهمة للمشروع هي كما يلي. - إجراء تدقيق شامل للمحتوى - إنشاء بنية معلومات لفهم تدفق المعلومات - تحسين بنية المعلومات لإعادة تنظيم الوثائق - تحديد الروابط والمراجع بين الأقسام المختلفة من المحتوى - إعادة كتابة/تعديل أجزاء من الوثائق، إذا لزم الأمر لتلبية متطلبات إعادة الضبط
- التأكد من أن المحتوى مرن وقابل لإعادة الاستخدام
وصف المشروع يُعدّ تكوين ESLint ميزة مهمة، وهي ميزة تجعل ESLint قابل للتخصيص. من المؤكد أن المستخدمين المهتمين بالتهيئة سيكونون مهتمين بعنصر أو جانبين في وقت معين. لذلك، من المهم أن يتم توجيه المستخدم إلى الموضوع الذي يهمه، وبالتالي تزويده بالحل بطريقة فعالة. تحتوي الحالة الحالية لوثائق تهيئة ESLint على الكثير من المعلومات المفيدة ولكنها منظمة بطريقة يمكن أن تجعل المستخدمين يشعرون بالإرهاق والإحباط والضياع. على سبيل المثال، إذا كان أحد المستخدمين مهتمًا بالتعرّف على استخدام المكوّنات الإضافية التابعة لجهات خارجية في ESLint، سيتعين عليه الانتقال لأسفل خلال المناقشة حول تحديد المحلِّل اللغوي والبيئات وglobals. الممارسة بأكملها هي مملة للمستخدمين ويمكن أن تؤدي إلى ابتعادهم عن الموقع الإلكتروني. وبالمثل، إذا كان المستخدم في مكان ما في منتصف الصفحة ويريد الانتقال إلى قسم معين أو مجرد إلقاء نظرة على موضوعات مماثلة، فلن تكون مهمة سهلة بالنسبة له، حيث لا يتم تقديم مثل هذه المساعدة للمستخدمين. تحتاج هذه المشكلات إلى اهتمام فوري لأن جودة أي وثائق، بغض النظر عن مدى صياغتها، تعتمد على فائدتها. أقترح حلولاً لهذه المشكلات وغيرها من المشكلات ذات الصلة في المناقشة التالية.
تدقيق المحتوى تتمثل الخطوة الأولى في عملية إعادة تنظيم وثائق التهيئة في إجراء تدقيق شامل للمحتوى. يهدف التدقيق إلى تحديد بعض المشاكل الرئيسية، مثل المحتوى القديم والمحتوى المكرّر وغير المتوفّر. وستتم مشاركة جدول بيانات تدقيق المحتوى الذي يتم إنشاؤه نتيجةً لذلك مع فِرق الإدارة والتوثيق للحصول على ملاحظاتهم وآرائهم. سيساعد هذا في التوصل إلى استراتيجية جديدة لهيكلة الوثائق وتقديمها.
إنشاء بنية المعلومات لفهم شبكة المعرفة أو تدفق المعلومات في وثائق التهيئة، يمكن أن يكون إنشاء بنية المعلومات (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: الروابط والمراجع سأحلّل "بنية المعلومات" خلال هذه المرحلة لتحديد الروابط والمراجع بين أقسام مختلفة من الوثائق. سأقوم أيضًا بإنشاء تسلسل هرمي لجميع الأقسام، مما يؤدي إلى تحسين بنية المعلومات في هذه العملية.
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: التعديلات الثانية سخصص بعد ذلك فترة أربعة أيام لتعديل المستند. وستتم مناقشة الإصدارات المنتجة نتيجةً لذلك مع المرشدين من أجل إعطائهم الشكل النهائي. عند الانتهاء من هذه المرحلة، ستكون الوثائق في شكلها النهائي، جاهزة للتحميل على موقع الويب ومستودع جيت هب.
20 تشرين الثاني (نوفمبر) 2020 - 23 تشرين الثاني (نوفمبر) 2020: جارٍ التحميل على الموقع الإلكتروني بعد إجراء كل التعديلات اللازمة، سيتم تحميل المستندات إلى الموقع الإلكتروني. وسيتم التعامل مع أي مشاكل تواجهها في هذه العملية وفقًا لذلك لأنّه لا يزال لدينا بضعة أيام للعمل على المستندات.
24 نوفمبر 2020 - 28 نوفمبر 2020: تقرير المشروع سيتم إنشاء تقرير مفصل عن المشروع خلال هذه الفترة التي تبلغ خمسة أيام. ستشكل الأهداف والمصاعب والمشكلات والحلول المقدمة جزءًا من تقرير المشروع. ستتم مشاركة التقرير مع المرشدين للحصول على الملاحظات.
29 تشرين الثاني (نوفمبر) 2020 - 30 تشرين الثاني (نوفمبر) 2020: الإرسال النهائي سيتم إرسال المشروع، مع جميع الملفات، وتقرير المشروع إلى المرشدين. سيتم إجراء مراجعة للمشروع بأكمله من خلال اجتماع/مناقشة مع المرشدين والفرق المعنية.
طوال فترة المشروع، سأستمر في استشارة المرشدين للحصول على ملاحظاتهم القيّمة. يمكن تغيير كل هذه الإنجازات بناءً على المناقشات مع المرشدين في فترات ترابط المجتمع ومراجعة الاقتراحات.
نبذة عني لديّ شهادة جامعية في الهندسة الكهربائية وشهادة عليا في الاتصالات التقنية والمهنية من جامعة ولاية كارولينا الشمالية. لدي خبرة في مجالات الكتابة والتحرير الفنية والمهنية، والتواصل وإدارة المحتوى، ودراسات قابلية الاستخدام على الويب والأجهزة المحمولة، وتصميم التعليمات. عملت كمحرر فرعي في منشور على الإنترنت (Global Village Space) ومتدرب في مجال الاتصالات لدى Duke Forge في جامعة ديوك. إلى جانب ذلك، لديّ أيضًا اهتمام بالكتابة الإبداعية.