فاز فعلی:
برنامه Season of Docs 2021 در 14 دسامبر 2021 به پایان رسید. جدول زمانی را ببینید.
این صفحه حاوی نکاتی برای سازمان های منبع باز در مورد نحوه ارزیابی و انتخاب نویسنده فنی مناسب برای پیشنهاد پروژه Season of Docs است.
معرفی
سازمان های متن باز باید یک نویسنده فنی را برای کار روی پروژه پیشنهادی خود استخدام کنند. سازمان ها باید نویسنده فنی خود را تهیه کنند. نویسندگان فنی علاقه‌مند به کار با سازمان‌های شرکت‌کننده در Season of Docs را می‌توانید در مخزن Season of Docs GitHub و در کانال #season-of-docs در Write the Docs Slack پیدا کنید.
ارزیابی یک نویسنده فنی
توصیه می شود از نویسندگان فنی مورد نظر خود نمونه هایی از مستندات توسعه یافته قبلی را درخواست کنید تا بتوانید بر ارزیابی مهارت ها و تجربه فنی نوشتاری آنها تمرکز کنید.
مهارت و تجربه فنی نوشتاری
تجربه قبلی نویسنده فنی را بررسی کنید. در حالت ایده آل، نویسنده فنی باید تجربه قبلی در نوشتن اسناد فنی برای صنعت نرم افزار داشته باشد. یکی از اهداف Season of Docs این است که به نویسندگان فنی این فرصت را بدهد تا با محصولات متمرکز بر توسعه‌دهنده درگیر شوند. به همین دلیل، ضروری نیست که نویسنده تجربه با APIها یا SDKها یا دیگر پلتفرم‌های توسعه‌دهنده داشته باشد، حتی اگر پروژه شما بر روی مخاطبان توسعه‌دهنده متمرکز باشد.
بر مهارت های زبانی و ارتباطی تمرکز کنید. کار قبلی نویسنده فنی را از این منظر ارزیابی کنید. مهمتر از همه: آیا می توانید بفهمید که آن شخص چه نوشته است؟ اگر می خواهید به بررسی عمیق زبان کار نویسنده فنی بپردازید، به دنبال ثبات در نقطه گذاری و عبارت، املای صحیح و زبان واضح باشید. آیا عبارت ساده است یا پیچیده؟ آیا جملات کوتاه هستند یا آنقدر ادامه می یابند که دنبال کردنشان سخت شود؟
به طراحی و چیدمان سند توجه کنید. طرح کلی نمونه(های) سند را بررسی کنید. آیا طراحی منطقی است؟ آیا می توانید به راحتی راه خود را در مورد اسناد یا مجموعه اسناد پیدا کنید؟ آیا مطالب تکراری وجود دارد یا شکاف های آشکاری وجود دارد؟