تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول ضمن "موسم المستندات" من Google.
ملخص المشروع
- مؤسسة البرامج المفتوحة المصدر:
- البرازيل الكندي البرازيلي
- الكاتب الفني:
- ساهبكور
- اسم المشروع:
- دليل المبتدئين إلى ريال برازيلي (BRL-CAD)
- طول المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
دليل المبتدئين إلى عملة BRL-CAD
ملخص المشروع
يهدف هذا المشروع إلى إنشاء وثائق مكرّسة للمستخدمين الذين ليسوا جددًا في BRL-CAD فحسب، بل يستفيدون منها أيضًا في البرامج المفتوحة المصدر.
لماذا هذا المشروع
عندما زرت موقع BRL-CAD الإلكتروني لأول مرة، كنت مثقلاً بكمية المعلومات المتوفّرة في سوق العمل مفتوح المصدر وBRL-CAD، ولكن في عمقي كنت أعرف أنّ هناك الكثير لأتعلّمه هنا. لذا، أردتُ إنشاء مستندات للمستخدمين الجدد مثلي للاستفادة كثيرًا من هذا المنتدى والشعور بالراحة في بدء الاستخدام.
الأهداف
سيستهدف هذا المشروع مستخدمين جدد. في ما يلي بعض النقاط التي تهدف وثائقي إلى تحقيقها: ضمان شعور المستخدمين الجدد بالراحة: بما أنّ هذه الوثائق تخص المستخدمين الجدد ليس فقط للمستخدمين الجُدد في ريال برازيلي، ولكن أيضًا تكون جديدة في البرامج المفتوحة المصدر.
لتحقيق ذلك، سوف:
- يُرجى التأكّد من إبقاء درجة Flesch-Kincaid الخاصة بالمستند أعلى من 50. وفقًا لطريقة فليش-كينكايد، كلما زادت الدرجة، كان فهمها أسهل. يمكنك التحقق من درجة سهولة القراءة على الإنترنت.
- استخدم قوائم نقطية أو مرقمة حتى لا يصاب القراء بالملل أو يشتت انتباههم بالفقرات الطويلة.
- استخدم فقرات وجمل أقصر لأنها تتطلب قدرًا أكبر من الجهد العقلي لقراءة الجمل الطويلة وفهمها.
- استخدم العناوين الفرعية لتقسيم النص. الوثائق جيدة التنظيم: تلعب الوثائق جيدة التنظيم دورًا مهمًا في توجيه المستخدمين الجدد. يمنعهم ذلك من الضياع، ويسمح لهم بمعرفة أين يتجهون وما يفعلونه. لتحقيق ذلك، قمتُ بإنشاء خريطة ذهنية تقريبية يمكن أن تساعدنا في توثيق دليل المبتدئين هذا بطريقة منظمة.
وصف المشروع
يركز هذا المشروع على كتابة الوثائق للمستخدمين الجدد للحصول على هذا البرنامج.
في ما يلي مثال على الطريقة التي أعني بها جعل المستندات وصفية أكثر.
مقدمة أساسية: BRL-CAD (تُنطق بـ be-are-el-cad) عبارة عن تصميم صلب للهندسة الصلبة بمساعدة الكمبيوتر (CSG). وهو نظام نمذجة صلب قوي عبر النظام الأساسي ومفتوح المصدر للتصميم ثلاثي الأبعاد بمساعدة الكمبيوتر والتصور الرسومي. ألا تجد نفسك بحاجة إلى المساعدة؟ إليك شرح مفصّل: البرامج المفتوحة المصدر: البرامج المفتوحة المصدر هي برنامج يحتوي على رمز مصدر يمكن لأي شخص فحصه وتعديله وتحسينه. ونظرًا لكون BRL-CAD برنامجًا مفتوح المصدر، فإنّنا نرحب بك بالمساهمة وجعل BRL-CAD أفضل من ذي قبل. التصميم بمساعدة الكمبيوتر (CAD): يعني هذا المصطلح ببساطة استخدام برامج الكمبيوتر لإنشاء تمثيل رسومي ثنائي أو ثلاثي الأبعاد للأشياء المادية. نظام النمذجة الصلبة: تركز BRL-CAD على تصميم النماذج الصلبة CAD. وتتميّز النمذجة الصلبة عن الأشكال الأخرى من النمذجة الهندسية من خلال التركيز على دقتها المادية ووصف المساحة الثلاثية الأبعاد بالكامل. إنه يحاكي كائنًا داخليًا وخارجيًا. الهندسة الصلبة البناءة (CSG): تتيح CSG تمثيل النماذج المعقدة كسلسلة من العمليات المنطقية بين العناصر الأولية. تسمى أبسط الكائنات الصلبة المستخدمة في التمثيل العناصر الأساسية. للاطّلاع على مصطلح CSG بشكل أساسي، انتقِل إلى هذا الرابط.
*كما هو مذكور في وصف فكرة المشروع: ستتناول الوثائق بشكل بسيط التركيبة الأساسية، ووصفًا شاملاً للإمكانات، لمبادئ وضع النماذج بالريال البرازيلي، والاستخدام الأساسي للأدوات الرئيسية، ووضع النماذج، والاستيراد/التصدير، والتحليل والعرض.
الترتيب عبارة عن مقدمات موجزة عن كيفية تناول كل جزء في الوثائق.
- التثبيت الأساسي: سأضيف برنامجًا تعليميًا تفصيليًا لتثبيت برنامج BRL-CAD مع لقطات الشاشة المطلوبة. يعد البرنامج التعليمي للمبتدئين مكانًا رائعًا ليبدأ المستخدمون الجدد به. بعض الأشياء التي أجدها مفقودة هي:
- خطوات هذا البرنامج التعليمي للمبتدئين ليست نقطية أو مرقمة. إن وجود برنامج تعليمي خطوة بخطوة مع لقطة شاشة في نهاية كل خطوة يزيد من احتمالية أن ينجذب المستخدم إلى البرنامج التعليمي.
- وصف شامل للقدرات: سيحتوي هذا القسم على جميع المجالات التي يتيح لـ BRL-CAD إظهار العجائب فيها. سيكون النهج التخطيطي طريقة أفضل لجذب الانتباه نحو هذا الجزء.
- مبادئ نمذجة BRL-CAD: سيتطلب هذا الجزء مزيدًا من الشرح لأنّ المستخدم يمكنه فهم BRL-CAD بشكلٍ أفضل بعد التعرّف بشكلٍ قوي على مبادئ النمذجة هذه.
- الاستخدام الأساسي للأدوات الرئيسية: ضمن ذلك، ستكون لدينا برامج تعليمية منفصلة عن الأدوات الرئيسية واستخدامها الأساسي. ستكون هذه برامج تعليمية تدريجية.
- تصدير/استيراد: سيتمكّن المستخدمون من الاطّلاع على "مكتبة الإحالات الناجحة في مجال الهندسة". تحويل الأشكال الهندسية من تنسيق إلى تنسيق آخر أحد الاستخدامات الأكثر شيوعًا لـ BRL-CAD في هذا القسم، سنناقش المستخدمين الذين أجروا إحالات ناجحة للتصدير والاستيراد.
- العرض: سنتناول أساسيات العرض والحاجة إليه في برامجنا. وسيتعرف المستخدمون أيضًا على كيفية عرض الصور بالريال البرازيلي (CAD).
بصرف النظر عن ذلك، ينصبّ التركيز أيضًا على النقاط التالية:
- سيكون في بداية الوثائق فهم أساسي لما يدور حوله هذا البرنامج.
- كيف يمكن للمستخدمين التواصل مع هذا المنتدى مفتوح المصدر. رابط إلى محادثة zulip BRL-CAD
- على المستوى التجريدي، يجعل التوثيق مضحكًا بعض الشيء ويطلب من المستخدمين الجدد عدم الشعور بالإحباط من الكلمات الكبيرة. أحببتُ النهج التعاطفي المستخدم في الصفحة الرئيسية لموقع Wiki لـ BRL-CAD.
- سيحتوي على لقطات شاشة لبعض الأشياء الرائعة التي يمكن للمستخدمين القيام بها باستخدام هذا البرنامج.
الإنجازات
تموز (يوليو) (فترة مراجعة العرض)
- سأعرف نفسي أكثر بالبرنامج ومستندات ويكي أثناء استعراض البرامج التعليمية الحالية.
- سأُجري تحسينات على المستندات الحالية.
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 تشرين الثاني (نوفمبر)
- العمل على Docbook XML
من 6 إلى 12 تشرين الثاني (نوفمبر)
- اطلب مراجعات من المرشدين وأعضاء المنتدى الآخرين واعمل على التغييرات.
- المناقشة مع المرشدين وإجراء التغييرات النهائية.
من 12 إلى 22 تشرين الثاني (نوفمبر)
- عملية المناقشة والتغييرات.
- إعطاء لمسة نهائية على الوثائق.
لمحة عني
بدأتُ في الكتابة منذ أيام دراستي. كنت أعود إلى المنزل من المدرسة وأكتب كل شيء عن يومي، وما الذي جعلني يوم أفضل أو أسوأ. وكنت دائمًا حريصة على تدوين الأخطاء التي ارتكبتها، وكيف يمكنني تحسينها.
أثناء تدريبي كمصمم ويب، طُلب منا تدوين ما نتعلمه يوميًا. أود توثيق بعض المشكلات التي واجهتها والحل المرتبط بها.
كشخص، أبذل قصارى جهدي دائمًا لمساعدة الآخرين. خلال أيام المدرسة والكلية، كنت أشرح بعض الموضوعات لأصدقائي بعد فهمها بنفسي. تُعد المشاركة في GSoD خطوة رائعة يمكنني من خلالها، بصفتي كاتبًا، المساهمة في جعل هذا المنتدى مفتوح المصدر أكثر جاذبية وإفادة للمستخدمين الجدد في جميع أنحاء العالم.