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