المرحلة الحالية:
تطوير المستندات: يمكنك الاطّلاع على المخطط الزمني.
في ما يلي بعض الإرشادات لمساعدة مؤسسات البرامج مفتوحة المصدر على العمل بفعالية مع الكتّاب الفنيين.
تعريف الكاتب التقني بعالم البرامج المفتوحة المصدر وبالمنتدى الخاص بك
- يمكنك منح الكاتب التقني "جولة إرشادية" في المنتدى الخاص بك. أين يمكنه طرح الأسئلة؟ ما الاجتماعات المنتظمة التي يجب أن يحضرها، أو ما القوائم البريدية التي ينبغي عليه الانضمام إليها؟ ما هي الحسابات التي يحتاجون إليها (GitHub وDiscord وSlack)؟ تأكد من فهمهم لقواعد السلوك الخاصة بمشروعك ومعرفة كيفية الإبلاغ عن أي مشكلات. تأكد من أن الكاتب الفني يفهم ترخيص مشروعك ويلتزم بأي متطلبات لأصحاب العمل الآخرين بشأن التوقيع على اتفاقية ترخيص المحتوى (CLA) أو بنود حماية البيانات (DCOs) أو أي اتفاقيات أخرى.
- إن أمكن، عرّفهم على عدد قليل من الأشخاص في المناطق الزمنية المتداخلة ويمكنهم الرد بسرعة على الأسئلة المتعلقة بالمجتمع أو المشروع.
- إذا أمكن، أرسل لهم بعض هدايا المشروع!
ساعد الكاتب التقني في استخدام الأدوات والعمليات المتضمنة في المساهمة في مشروعك
- إذا لم تكن عملياتك موثَّقة جيدًا، حدِّد وقتًا لإطلاع المؤلف التقني على أول مساهمة أو مشكلة أو طلب للحصول على موافقة المستخدم. ما القوالب أو العلامات التي يجب أن يستخدمها؟ من يحتاج إلى مراجعة مساهماته، وكيف ومتى يجب عليه متابعة المراجعات؟ إذا كان عملهم يتضمن عينات تعليمات برمجية، كيف يمكن اختبارها؟ ما الذي يحتاجون إلى معرفته عن عمليات CI/CD أو الإصدارات؟
ساعد الكاتب الفني في فهم مشروعك ومستخدميه
- اشرح مشروعك بالتفصيل حتى يكتسب الكاتب الفني فهمًا مفهومًا راسخًا للمنتج. وهذا يمكن أن يساعد الكاتب التقني في أن يشعر بمزيد من الثقة وأن يكون أكثر موثوقية في كتابته للمشروع.
- وصف احتياجات الأشخاص الذين يستخدمون المشروع. كن محددًا بقدر ما يمكنك - ليس فقط "المطورون" ولكن "المطورون الذين ينشئون مواقع الويب" و"المطورون الذين يبرمجون الروبوتات الصناعية".
- جعل الكاتب الفني على اتصال بالخبراء المختصين في الموضوع. أي، المطورين أو المساهمين الآخرين في المشروع المسئولين عن جوانب مشروعك التي ستتناولها الوثائق.
- تأكد من أن الكاتب الفني يحصل على الوقت والموارد التي يحتاجها من الخبراء المختصين وأي أعضاء آخرين في المنتدى.
طرح الأسئلة
- ربما لم يعمل المنتدى أو المشروع مع الكتاب الفني أو المساهمين في الوثائق من قبل. استغل فرصة التعلم بينما تشارك ما تعرفه! اطلب ملاحظات حول عملياتك وأدواتك - فمن المحتمل أن يكون لدى الكاتب الفني بعض الاقتراحات للتحسين.