تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول في موسم Google من المستندات.
ملخّص المشروع
- مؤسسة مفتوحة المصدر:
- BRL-CAD
- الكاتب الفني:
- sahibkaur
- اسم المشروع:
- دليل المبتدئين لاستخدام BRL-CAD
- مدة المشروع:
- مدة زمنية عادية (3 أشهر)
وصف المشروع
دليل المبتدئين إلى عملة الريال البرازيلي (BRL-CAD)
ملخص المشروع
يهدف هذا المشروع إلى إنشاء مستندات مخصّصة للمستخدمين الذين ليسوا مبتدئين في BRL-CAD فحسب، بل هم مبتدئون أيضًا في البرامج مفتوحة المصدر.
لماذا هذا المشروع
عندما زرتُ موقع BRL-CAD الإلكتروني لأول مرة، شعرتُ بالارتباك بسبب كمية المعلومات التي ظهرت لي دفعةً واحدة، لأنّني كنتُ مبتدئًا في استخدام البرامج مفتوحة المصدر وBRL-CAD. ولكنّني كنت أعلم في قرارة نفسي أنّ هناك الكثير من المعلومات التي يمكنني تعلّمها. لذلك، أردت إنشاء مستندات للمستخدمين الجدد مثلي للاستفادة إلى أقصى حد من هذا المجتمع والشعور بالراحة عند البدء.
الأهداف
سيستهدف هذا المشروع مستخدمين جددًا. في ما يلي بعض النقاط التي تهدف إلى تحقيقها في هذه المستندات: لضمان شعور المستخدمين الجدد بالراحة: بما أنّ هذه المستندات مخصّصة للمستخدمين الجدد الذين ليسوا جددًا فقط في BRL-CAD ولكنهم أيضًا جدد في البرامج مفتوحة المصدر.
لتحقيق ذلك، سأنفّذ ما يلي:
- احرص على أن تكون نتيجة Flesch-Kincaid للمستند أعلى من 50 على الأقل. وفقًا لطريقة Flesch-Kincaid، كلما ارتفعت النتيجة، كان من الأسهل فهم القطعة. يمكنك الاطّلاع على نتيجة سهولة القراءة على الإنترنت.
- استخدم القوائم النقطية أو المرقمة حتى لا يشعر القراء بالملل أو تشتيت الانتباه بالفقرات الطويلة.
- استخدِم فقرات وجملاً أقصر لأنّ قراءة الجمل الطويلة وفهمها يتطلّب جهداً عقليًا أكبر مقارنةً بالجمل القصيرة.
- استخدِم العناوين الفرعية لتقسيم النص. التوثيق المهيكل: يلعب التوثيق المهيكل جيدًا دورًا مهمًا في توجيه المستخدمين الجدد. ويساعدهم ذلك في عدم الضياع ومعرفة وجهتهم ونشاطهم. لتحقيق ذلك، أنشأت خريطة ذهنية تقريبية يمكن أن تساعدنا في توثيق دليل المبتدئين هذا بطريقة منظمة.
وصف المشروع
يركز هذا المشروع على كتابة مستندات للمستخدمين الجدد للاستفادة من هذا البرنامج.
في ما يلي مثال على كيفية تحسين الوثائق لتكون أكثر وصفية.
مقدمة أساسية: BRL-CAD (يُنطق اسمه "be-are-el-cad") هو تصميم صلب للتصميم بمساعدة الكمبيوتر (CAD) بناء على هيئة هندسية صلبة. وهو نظام فعّال ومفتوح المصدر للنمذجة الصلبة على جميع الأنظمة الأساسية، ويُستخدَم للتصميم الثلاثي الأبعاد بمساعدة الكمبيوتر وعرض الرسومات. هل لا يمكنك فهم ذلك؟ إليك شرح مفصّل: البرامج المفتوحة المصدر: البرامج المفتوحة المصدر هي برنامج يحتوي على رمز مصدر يمكن لأي شخص فحصه وتعديله وتحسينه. يرحّب بك البرنامج مفتوح المصدر الريال البرازيلي (BRL-CAD) بالمساهمة وجعل الريال البرازيلي أفضل من ذي قبل. التصميم بمساعدة الكمبيوتر (CAD): بكلمات بسيطة، التصميم بمساعدة الكمبيوتر هو استخدام برامج الكمبيوتر لإنشاء تمثيل بياني ثنائي أو ثلاثي الأبعاد للكائنات المادية. نظام التصميم بالأشكال الصلبة: تركّز أداة BRL-CAD على التصميم بالأشكال الصلبة. ويختلف التصميم بالأشكال الصلبة عن أشكال التصميم الهندسي الأخرى من خلال التركيز على الدقة المادية ووصف المساحة الثلاثية الأبعاد بالكامل. وهو يحاكي الجسم من الداخل والخارج. الهندسة الصلبة التركيبية (CSG): تسمح الهندسة الصلبة التركيبية بتمثيل النماذج المعقّدة كسلسلة من العمليات المنطقية بين العناصر الأساسية. أبسط الأجسام الصلبة المستخدمة في التمثيل تسمى العناصر الأولية. لفهم CSG بشكل أساسي، يُرجى الانتقال إلى هنا.
*كما ذُكر في وصف فكرة المشروع: ستتناول الوثائق بشكل بسيط التركيب الأساسي، ووصفًا عامًا للإمكانات، لمبادئ نمذجة الريال البرازيلي-CAD، والاستخدام الأساسي للأدوات الرئيسية، ووضع النماذج، والاستيراد/التصدير، والتحليل، والعرض.
إليك مقدمات موجزة حول كيفية تغطية كل جزء في المستندات.
- التثبيت الأساسي: سأضيف دليلاً تعليميًا مفصّلاً لتثبيت برنامج BRL-CAD مع لقطات الشاشة المطلوبة. إنّ البرنامج التعليمي للمبتدئين هو مكان جيد للمستخدمين الجدد للبدء. في ما يلي بعض العناصر التي أرى أنّها غير متوفّرة:
- لا يتم استخدام أرقام أو نقاط في خطوات هذا الدليل التعليمي المخصّص للمبتدئين. من خلال توفير دليل تعليمي مفصّل مع لقطة شاشة في نهاية كل خطوة، من المرجّح أن ينجذب المستخدم إلى الدليل التعليمي.
- وصف عام للإمكانات: سيتضمّن هذا القسم جميع المجالات التي يمكن أن يُظهر فيها BRL-CAD قدراته الرائعة. سيكون من الأفضل استخدام مخطّط بياني لجذب الانتباه إلى هذا الجزء.
- مبادئ نمذجة BRL-CAD: سيتطلب هذا الجزء مزيدًا من الشرح لأن المستخدم يمكنه فهم الريال البرازيلي-CAD بشكل أفضل بمجرد فهمه جيدًا لمبادئ النمذجة هذه.
- الاستخدام الأساسي للأدوات الرئيسية: ضمن هذا القسم، سنقدّم دروسًا تعليمية منفصلة عن الأدوات الرئيسية واستخداماتها الأساسية. ستكون هذه البرامج التعليمية مفصّلة.
- التصدير/الاستيراد: سيتعرّف المستخدمون على "مكتبة تحويل الأشكال الهندسية". أحد الاستخدامات الأكثر شيوعًا للريال البرازيلي-CAD هو تحويل الأشكال الهندسية من تنسيق إلى آخر. ضمن هذا القسم، نناقش محوِّلات التصدير والاستيراد.
- العرض: سنتناول أساسيات العرض والحاجة إليه في برامجنا. وسيتعرّف المستخدمون أيضًا على كيفية عرض الصور بالريال البرازيلي/الدولار الكندي.
بالإضافة إلى ذلك، يتم التركيز أيضًا على النقاط التالية:
- ستتضمّن بداية المستندات فهمًا أساسيًا لما يدور حوله هذا البرنامج.
- كيف يمكن للمستخدمين التواصل مع هذا المنتدى مفتوح المصدر؛ رابط إلى محادثة zulip بـ BRL-CAD
- على مستوى مجرد، يمكنك إضفاء بعض الفكاهة على المستندات وطلب من المستخدمين الجدد عدم الشعور بالإحباط بسبب الكلمات الطويلة. أعجبني الأسلوب التعاطفي المستخدَم في الصفحة الرئيسية لـ BRL-CAD wiki.
- سيتضمّن الفيديو لقطات شاشة لبعض الإجراءات الرائعة التي يمكن للمستخدمين تنفيذها باستخدام هذا البرنامج.
الإنجازات
تموز (يوليو) (فترة مراجعة الاقتراحات)
- سأتعرّف أكثر على البرنامج ومستندات الموسوعة على الإنترنت أثناء الاطّلاع على الأدلة التعليمية الحالية.
- سأُجري تحسينات على المستندات الحالية.
من 1 آب (أغسطس) إلى 7 آب (أغسطس) (التواصل مع المجتمع)
- مناقشة المشروع مع المرشدين
- تحسين تفاصيل المشروع
- أدخِل التغييرات المطلوبة في المعالم (إذا لزم الأمر).
من 8 إلى 14 آب (أغسطس)
- التعرّف على Docbook XML
15 آب (أغسطس) - 21 آب (أغسطس)
- كتابة مستندات عن "مقدمة أساسية إلى BRL-CAD"
- كتابة دليل تعليمي مفصّل حول "التركيب الأساسي"
من 22 إلى 27 آب (أغسطس)
- التعرّف على الإمكانيات المتنوعة للريال البرازيلي (BRL-CAD) وإدراجها مع لقطات شاشة
- شرح الميزات الفردية في صفحة منفصلة
28 آب (أغسطس) - 3 أيلول (سبتمبر)
- مواصلة العمل على المستندات الفردية للاستفادة من الإمكانات
4 أيلول (سبتمبر) - 10 أيلول (سبتمبر)
- العمل على مبادئ النمذجة.
- شرح جميع مبادئ وضع النماذج
من 11 إلى 17 أيلول (سبتمبر)
- العمل على الاستخدام الأساسي للأدوات الرئيسية.
- عمل قائمة مختصرة بأفكار لتوثيق الاستخدام الأساسي لكل أداة.
من 18 إلى 24 أيلول (سبتمبر)
- توثيق استخدام كل أداة.
من 25 أيلول (سبتمبر) إلى 1 تشرين الأول (أكتوبر)
- احرص على إنشاء نموذج قوي للدليل التعليمي وكتابة مسودة إلى جانبه.
من 2 إلى 8 تشرين الأول (أكتوبر)
- تحسين مسودة وضع النماذج
من 2 إلى 8 تشرين الأول (أكتوبر)
- دراسة محوِّلات التصدير والاستيراد
من 9 إلى 15 تشرين الأول (أكتوبر)
- إعداد مستندات التصدير والاستيراد
- ابدأ العمل على العرض.
من 16 إلى 22 تشرين الأول (أكتوبر)
- توثيق البرنامج التعليمي الخاص بالعرض
من 23 إلى 29 تشرين الأول (أكتوبر)
- مراجعة جميع المستندات
30 تشرين الأول (أكتوبر) - 5 تشرين الثاني (نوفمبر)
- العمل على ملف XML الخاص بـ Docbook
من 6 إلى 12 تشرين الثاني (نوفمبر)
- اطلب مراجعات من المرشدين وأعضاء المجتمع الآخرين واعمل على إجراء التغييرات.
- مناقشة الأمر مع المرشدين وإجراء التغييرات النهائية
من 12 إلى 22 تشرين الثاني (نوفمبر)
- عملية المناقشة والتغييرات.
- إضافة اللمسات الأخيرة إلى المستندات
لمحة عني
كنت أعمل في مجال الكتابة منذ أيام مدرستي. كنت أعود إلى المنزل من المدرسة وأكتب كل شيء عن يومي، وما جعل يومي أفضل أو أسوأ. كنت دائمًا حريصًا على تدوين الأخطاء التي أرتكبها وكيفية تحسينها.
خلال فترة تدريبي كمصمّم مواقع إلكترونية، طُلب منا تدوين ما نتعلمه يوميًا. سأوثّق بعض المشاكل التي واجهتها والحلول التي تم اتّخاذها.
أبذل قصارى جهدي دائمًا لمساعدة الآخرين. خلال أيام الدراسة الجامعية، كنت أشرح بعض المواضيع لأصدقائي بعد فهمها بنفسي. إنّ المشاركة في GSoD هي خطوة رائعة يمكنني من خلالها، بصفتي كاتبًا، المساهمة في جعل هذا المنتدى المخصّص للبرامج المفتوحة المصدر أكثر تفاعلاً وإفادة للمستخدمين الجدد في جميع أنحاء العالم.