المرحلة الحالية:
انتهى برنامج "موسم 2019" لعام 2019 في 6 آذار (مارس) 2020. اطّلِع على
المخطط الزمني.
أفكار المشاريع هي اقتراحات من مؤسسة مفتوحة المصدر للمشاريع التي يمكن للكاتب التقني إكمالها بالتعاون مع مرشد خلال Season of Docs.
المعلومات الواردة في هذه الصفحة مخصصة لمشرفي وموجهي المؤسسات مفتوحة المصدر الذين يقومون بإعداد قائمة أفكار المشروعات الخاصة بهم. وهذه المعلومات مفيدة أيضًا للكتّاب التقنيين كخلفية لمشاركة المؤسسات في Season of Docs.
أمثلة على المشاريع
فيما يلي بعض الأفكار حول نوع المشروع الذي يمكن للكاتب التقني معالجته:
أنشئ موقعًا للوثائق على نظام أساسي ليقرره الكاتب الفني والمرشد مفتوح المصدر، ثم انشر مجموعة أولية من المستندات الأساسية على الموقع. تتضمن أمثلة المنصات ما يلي:
- قراءة المستندات
- أداة إنشاء للمواقع الإلكترونية الثابتة مثل Hugo وJekyll وSphinx وغيرها
- صفحات GitHub
إعادة هيكلة الوثائق الحالية لمشروع مفتوح المصدر لتوفير تجربة مستخدم محسنة أو بنية معلومات أكثر سهولة في الوصول إليها.
كتابة نظرة عامة مفاهيمية أو مقدمة عن منتج أو ميزة. غالبًا ما ينشئ الفريق وثائقه الفنية من الأسفل إلى الأعلى، بنتيجة ذلك وجود الكثير من التفاصيل ولكن من الصعب فهم المنتج ككل. يمكن للكاتب التقني حل هذه المشكلة.
إنشاء برنامج تعليمي لحالة استخدام رفيعة المستوى.
يمكنك إنشاء مجموعة من الأدلة الإرشادية مركزة لمهام محدَّدة.
يمكنك إنشاء دليل مساهم يتضمن معلومات أساسية حول بدء العمل كمساهم في المشروع مفتوح المصدر، بالإضافة إلى أي قواعد حول اتفاقيات الترخيص وعمليات طلبات السحب والمراجعات وإنشاء المشروع وما إلى ذلك.
تختلف الأفكار المذكورة أعلاه عن قصد من حيث النطاق والحجم. وتعتمد المدة التي يستغرقها أي مشروع على عدد من العوامل، بما في ذلك حجم مجموعة الوثائق، وتعقيد المنتج، وخبرة الكاتب التقني والمرشدين مفتوحة المصدر، والأدوات والعمليات التي يوفرها المشروع مفتوح المصدر، وأكثر من ذلك.
إن الهدف من القائمة أعلاه هو مساعدتك على البدء. يمكنك اقتراح أنواع أخرى من المشروعات أيضًا.
نشر قائمة أفكار المشروع
يجب عليك نشر أفكار مشروعك على صفحة ويب عامة أو في مشاركة مدونة أو في بعض المستندات الأخرى المرئية للجمهور.
يجب أن تتضمن صفحة أفكار المشروع ما يلي:
معلومات حول مؤسستك مفتوحة المصدر:
- اسم المؤسسة
- وصف المؤسسة.
- تمثّل هذه السمة رابطًا يؤدي إلى مستودعك المفتوح المصدر و/أو موقعك الإلكتروني.
- (اختياري) عنوان بريد إلكتروني للاتصال بمؤسستك بشأن موسم المستندات. يجب أن يكون هذا هو نفس عنوان البريد الإلكتروني الذي تدرجه في نموذج طلب مؤسستك لـ Season of Docs.
- (اختياري) معلومات عن إدارة مؤسستك والمرشدين مثل الأسماء المعروضة لهم. يجب أن تكون هذه الأسماء هي نفسها الأسماء المعروضة التي تدرجها في نموذج طلب مؤسستك لخيار "موسم المستندات"
إعلان بأن مؤسستك تتقدم للمشاركة في موسم المستندات هذا العام. تتضمن صفحة العرض الترويجي والصحافة الشعارات والمحتوى الآخر الذي يمكنك استخدامه عند التحدث عن "موسم المستندات".
فكرة(أفكار) مشروعك، بما في ذلك المعلومات الموضحة أدناه لكل فكرة مشروع.
عند إنشاء تطبيق مؤسستك لـ Season of Docs، يجب عليك تضمين رابط لصفحة أفكار مشروعك.
المعلومات في كل فكرة مشروع
يجب أن تتضمن كل فكرة مشروع على الأقل المعلومات التالية:
- اسم المشروع: اختَر عنوانًا موجزًا ووصفيًا في الوقت نفسه.
- الوصف: تمثّل هذه السمة وصفًا أطول للعمل المطلوب على المستندات. صِف فكرتك الأولية بالتفصيل. أتاح الفرص لأي كتاب تقني مهتم لتوسيع الفكرة أو تحسينها.
مواد ذات صلة:
- رابط لمشروع المصدر المفتوح الذي يحتاج إلى توثيق.
- إذا كنت تقترح مشروعًا للكتابة الفنية يتضمّن تعديلات على مجموعة مستندات حالية، أدرِج رابطًا يؤدي إلى مجموعة المستندات هذه.
- إذا كنت تقترح برنامجًا تعليميًا أو مجموعة من الأدلة الإرشادية، صِف الميزات أو حالات الاستخدام التي تحتاج إلى التوثيق.
- إذا كنت تقترح دليلاً للمساهم، يمكنك إدراج رابط يؤدي إلى أي ملف README أو مواد أخرى ذات صلة في حال توفّره. إذا لم يكن هناك شيء متاح حتى الآن، فلا بأس أن تقول ذلك.
- قم بتضمين روابط لوثائق مماثلة في مشروعات أخرى، إذا كان ذلك مناسبًا.
أهمية أفكار المشروع
أفكار مشروعك مهمة بعدد من الطرق:
- يساعد العمل على الأفكار مؤسستك في صياغة مهام التوثيق المطلوبة والاستعداد للعمل مع كاتب تقني.
- تعطي أفكار المشروع لمشرفي برنامج Google مؤشرًا على نوع العمل الذي سيتعامل معه الكاتب التقني عندما يدخل في علاقة توجيهية مع مؤسستك. يستخدم مشرفو برنامج Google أفكار المشروع للحكم على التزام المؤسسة بالمشاركة في موسم المستندات وتوجيه الكاتب الفني طوال البرنامج.
- تجذب أفكار المشروع الكتاب التقني المهتمين إلى مؤسستك. يمكنهم استخدام مشروعاتك المقترحة كأساس لمقترحات المشروعات الخاصة بهم.
معلومات ذات صلة
- تتضمن صفحة العرض الترويجي والصحافة الشعارات والمحتوى الآخر الذي يمكنك استخدامه عند التحدث عن "موسم المستندات".
- يقدّم هذا الفيديو من PyCon Australia 2017 تلميحات حول تنظيم مستنداتك كي يستفيد منها المستخدمون: ما لا يخبرك به أحد عن المستندات من إعداد "دانييل بروسيدا".