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

المرحلة الحالية:
انتهى برنامج "موسم 2019" لعام 2019 في 6 آذار (مارس) 2020. اطّلِع على المخطط الزمني.

في ما يلي بعض الإرشادات لمؤسسات البرامج مفتوحة المصدر حول كيفية العمل مع كاتب تقني توجّه إرشاده إلى فريق Season of Docs:

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

نقاط يجب أخذها بالاعتبار

وليس بالضرورة أن يكون الموجّهون مفتوح المصدر في Season of Docs كُتّاب تقنيين. لا يحتاج الموجهون إلى مهارات التوثيق. يجلب الكتاب التقنيون تلك المهارات إلى المشروع وإلى العلاقة التوجيهية.

بدلاً من ذلك، يجلب المرشدون معرفتهم بمجتمع المصدر المفتوح والمنتج والعمليات والأدوات التي يستخدمها المشروع مفتوح المصدر.

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