العمل مع كاتب تقني

المرحلة الحالية:
يتم الإعلان عن النتائج. يمكنك الاطّلاع على المخطط الزمني.

في ما يلي بعض الإرشادات لمساعدة مؤسسات البرامج المفتوحة المصدر في العمل بفعالية مع المؤلفين الفنيين.

تعريف الكاتب التقني بعالم البرامج المفتوحة المصدر وبالمنتدى الخاص بك

  • يمكنك منح الكاتب التقني "جولة إرشادية" في المنتدى الخاص بك. أين يمكنهم طرح الأسئلة؟ ما الاجتماعات المنتظمة التي يجب أن يحضرها، أو ما القوائم البريدية التي يجب عليه الانضمام إليها؟ ما هي الحسابات التي يحتاجون إليها (GitHub وDiscord وSlack)؟ تأكد من فهمهم لمدونة السلوك الخاصة بمشروعك ومعرفة كيفية الإبلاغ عن أي مشكلات. تأكد من أن الكاتب الفني يفهم ترخيص مشروعك ويتفق مع أي متطلبات لأصحاب العمل الآخرين بشأن توقيع اتفاقيات ترخيص المحتوى (CLA) أو بنود حماية البيانات (DCOs) أو أي اتفاقيات أخرى.
  • إن أمكن، عرّفهم على عدد قليل من الأشخاص في المناطق الزمنية المتداخلة يمكنهم الرد بسرعة على الأسئلة حول المنتدى أو المشروع.
  • إذا أمكن، أرسل لهم بعض هدايا المشروع!

ساعد الكاتب التقني في استخدام الأدوات والعمليات المتضمنة في المساهمة في مشروعك

  • إذا لم تكن عملياتك موثَّقة جيدًا، يُرجى تحديد موعد لإطلاع الكاتب التقني على أول مساهمة أو مشكلة أو طلب للحصول على موافقة المستخدم. ما القوالب أو العلامات التي يجب أن يستخدمها؟ من يحتاج إلى مراجعة مساهماته، وكيف ومتى يجب متابعة المراجعات؟ إذا كان عملهم يتضمن عينات تعليمات برمجية، كيف يمكن اختبارها؟ ما الذي يحتاجون إلى معرفته عن عملية CI/CD أو الإصدارات؟

ساعد الكاتب الفني في فهم مشروعك ومستخدميه

  • اشرح مشروعك بالتفصيل حتى يكتسب الكاتب الفني فهمًا مفاهيمي راسخًا للمنتج. حيث يمكن أن يساعد هذا الكاتب التقني في الشعور بمزيد من الثقة وأن يكون أكثر موثوقية في كتابته للمشروع.
  • وصف احتياجات الأشخاص الذين يستخدمون المشروع. كن محددًا بقدر ما يمكنك - ليس فقط "المطورون" ولكن "المطورون الذين ينشئون مواقع ويب" و"المطورون الذين يبرمجون الروبوتات الصناعية".
  • جعل الكاتب الفني على اتصال بالخبراء المختصين في الموضوع. أي، المطورين أو المساهمين الآخرين في المشروع المسئولين عن جوانب مشروعك التي ستتناولها الوثائق.
  • التأكد من حصول الكاتب التقني على الوقت والموارد التي يحتاجها من الخبراء المختصين وأي أعضاء آخرين في المنتدى.

طرح الأسئلة

  • ربما لم يعمل المنتدى أو المشروع مع المؤلفين الفنيين أو المساهمين في الوثائق من قبل. استغل فرصة التعلم بينما تشارك ما تعرفه! اطلب ملاحظات حول عملياتك وأدواتك - من المحتمل أن يكون لدى الكاتب التقني بعض الاقتراحات للتحسين.