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