المرحلة الحالية:
انتهى برنامج "موسم 2021" لعام 2021 في 14 كانون الأول (ديسمبر) 2021. يمكنك الاطّلاع على المخطط الزمني.
تحتوي هذه الصفحة على نصائح لمؤسسات البرامج المفتوحة المصدر حول كيفية تقييم واختيار الكاتب الفني المناسب لاقتراح مشروع "موسم المستندات".
مقدمة
يجب على مؤسسات البرامج المفتوحة المصدر تعيين كاتب تقني للعمل في المشروع المقترح. يجب أن تحدّد المؤسسات كاتبها التقني. يمكنك العثور على الكُتّاب التقنيين المهتمين بالعمل مع المؤسسات المشاركة في ميزة "موسم المستندات" في مستودع Season of Docs GitHub وفي قناة#Season-of-docs في "كتابة مستندات Slack".
تقييم كاتب تقني
يوصى بطلب أمثلة على الوثائق التي تم تطويرها مسبقًا من الكُتّاب التقنيين الذين تفكر فيهم، حتى تتمكن من التركيز على تقييم مهاراتهم وخبراتهم الفنية في الكتابة.
مهارات وخبرات الكتابة التقنية
الاطّلاع على الخبرة السابقة للكاتب الفني من الناحية المثالية، يجب أن يكون لدى الكاتب الفني بعض الخبرة السابقة في كتابة الوثائق التقنية لصناعة البرمجيات. إن أحد أهداف Season of Docs هو منح الكتاب الفني الفرصة للمشاركة في المنتجات التي تركز على المطورين. لهذا السبب، ليس من الضروري أن يكون للكاتب خبرة في واجهات برمجة التطبيقات أو حزم SDK أو منصات المطورين الأخرى، حتى إذا كان مشروعك يركز على جمهور المطورين.
ركِّز على مهارات التواصل اللغوية والتواصل. تقييم العمل السابق للكاتب الفني من هذه وجهة النظر. والأهم من ذلك: هل يمكنك فهم ما كتبه هذا الشخص؟ إذا كنت تريد إجراء مراجعة متعمقة للغة عمل الكاتب الفني، فابحث عن الاتساق في علامات الترقيم والصياغة، والتهجئة الصحيحة، واللغة الواضحة. هل الصياغة بسيطة أم معقّدة؟ هل الجمل قصيرة أم أنها تعمل حتى يصبح من الصعب متابعتها؟
يجب الاهتمام بتصميم المستندات وتنسيقها. تحقَّق من التنسيق العام لعيّنات المستند. هل التصميم منطقي؟ هل يمكنك أن تجد طريقك بسهولة حول الوثيقة أو مجموعة الوثائق؟ هل هناك تكرار للمحتوى أو هل هناك ثغرات واضحة؟