فاز فعلی:
برنامه Season of Docs 2020 در 15 مارس 2021 به پایان رسید. جدول زمانی را ببینید.
این صفحه حاوی دستورالعمل‌هایی برای سازمان‌های منبع باز در مورد نحوه ارزیابی پیشنهادهای پروژه نگارش فنی و انتخاب پروژه‌هایی است که می‌خواهند در Season of Docs راهنمایی شوند.
معرفی
نویسندگان فنی پیشنهادات Season of Docs خود را برای کار بر روی یک پروژه با سازمان منبع باز انتخابی خود ارسال می کنند. مدیران برنامه Google پیشنهادات را برای ارزیابی و انتخاب پروژه به سازمان های منبع باز ارسال می کنند. برای جزئیات مراحل مربوطه، به راهنمای مدیر سازمان مراجعه کنید.
ارزیابی پیشنهادهای نویسنده فنی
مهارت و تجربه فنی نوشتاری
تجربه قبلی نویسنده فنی را بررسی کنید. پیشنهاد نویسنده فنی شامل اطلاعاتی در مورد آخرین تجربه نگارش فنی آنهاست. در حالت ایده آل، متقاضی باید تجربه قبلی در نوشتن اسناد فنی برای صنعت نرم افزار داشته باشد. یکی از اهداف Season of Docs این است که به نویسندگان فنی این فرصت را بدهد تا با محصولات متمرکز بر توسعه‌دهنده درگیر شوند. به همین دلیل، ضروری نیست که نویسنده تجربه با APIها یا SDKها یا دیگر پلتفرم‌های توسعه‌دهنده داشته باشد، حتی اگر پروژه شما بر روی مخاطبان توسعه‌دهنده متمرکز باشد.
بر مهارت های زبانی و ارتباطی تمرکز کنید. پیشنهاد نویسنده فنی را از این منظر ارزیابی کنید. مهمتر از همه: آیا می توانید بفهمید که آن شخص چه نوشته است؟ به عنوان یک مربی، نقش شما کمک به نویسنده فنی با فرآیندها، ابزارها و کدهای منبع باز خواهد بود—شما نمی خواهید متن اسناد حاصل را نیز مرور کنید. اگر می‌خواهید زبان پروپوزال را بررسی کنید، به دنبال سازگاری در علائم نگارشی و عبارت‌بندی، املای صحیح و زبان واضح باشید. آیا عبارت ساده است یا پیچیده؟ آیا جملات کوتاه هستند یا آنقدر ادامه می یابند که دنبال کردنشان سخت شود؟
به طراحی و چیدمان سند توجه کنید. به عنوان بخشی از پیشنهاد خود، نویسنده فنی این فرصت را دارد که نمونه هایی از اسنادی را که توسعه داده اند ارائه دهد. طرح کلی نمونه(های) سند را بررسی کنید. آیا طراحی منطقی است؟ آیا می توانید به راحتی راه خود را در مورد اسناد یا مجموعه اسناد پیدا کنید؟ آیا مطالب تکراری وجود دارد یا شکاف های آشکاری وجود دارد؟
پیشنهاد
بررسی کنید که پیشنهاد مطابق با نیازهای شما باشد. آیا این پیشنهاد با هر یک از ایده های پروژه ای که برای فصل مستندات امسال ارائه کرده اید، مرتبط است؟ اگر نویسنده فنی ایده جدیدی را پیشنهاد کرده است، بررسی کنید که این پیشنهاد با نیازهای پروژه منبع باز شما مطابقت دارد و افراد مناسبی برای کمک به نویسنده فنی در دستیابی به اهداف پروژه پیشنهادی دارید.
به دنبال اشتیاق و دقت باشید. آیا این پیشنهاد نشان می دهد که نویسنده فنی در مورد پروژه هیجان زده است؟ در نظر بگیرید که آیا آنها فکر و کار خود را در پروپوزال گذاشته اند، یا با مشورت با سازمان شما در مرحله اکتشاف، یا با اضافه کردن افکار خود در مورد چگونگی دستیابی به اهداف پروژه.
سوالات متداول
چگونه تصمیم بگیریم که چند پروژه ارسال کنیم؟
روی یک یا دو پروژه تمرکز کنید. اگر سازمان شما ظرفیت ارائه بیشتر از آن را دارد، می‌توانید موارد بیشتری را ارسال کنید. برای هر پروژه نویسنده فنی، حداقل به یک مربی (ترجیحاً دو نفر) نیاز دارید که متعهد باشد که فقط آن پروژه را راهنمایی کند.
اطلاعات مربوط به نحوه عملکرد تخصیص اسلات Season of Docs را بخوانید.
چگونه انتخاب کنیم که کدام پیشنهاد نگارش فنی را بپذیریم؟
مطمئن شوید که بهترین پیشنهادات نویسنده فنی را که دریافت کرده اید انتخاب کرده اید. به این معنی که پیشنهاداتی را انتخاب کنید که به بهترین وجه با نیازهای شما مطابقت دارند و با دستورالعمل های ارزیابی ذکر شده در بالا مطابقت دارند.
فرم هایی که برای ارسال پیشنهادات انتخابی نیاز داریم کجاست؟
راهنمای مدیر سازمان را ببینید.