فاز فعلی:
برنامه Season of Docs 2020 در 15 مارس 2021 به پایان رسید. جدول زمانی را ببینید.
این صفحه حاوی نکاتی برای نویسندگان فنی در مورد نحوه تکمیل بخش های کلیدی یک برنامه کاربردی برای شرکت در Season of Docs است. این اطلاعات به شما کمک می‌کند بفهمید سازمان‌های منبع باز هنگام انتخاب پروژه‌های نوشتاری فنی که می‌خواهند در طول فصل اسناد به آنها راهنمایی کنند، چه عواملی را در نظر می‌گیرند.
معرفی
دستورالعمل‌های زیر عموماً برای Season of Docs قابل اجرا هستند. هر سازمان منبع باز فردی ممکن است معیارهای ارزیابی خاصی داشته باشد. شما می توانید قبل از ارسال درخواست خود با هر یک از سازمان های شرکت کننده تماس بگیرید تا در مورد الزامات آنها صحبت کنید و طرح پیشنهادی خود را برنامه ریزی کنید. مرحله کاوش نویسنده فنی را که در راهنمای نویسنده فنی توضیح داده شده است، ببینید.
فرم درخواست
فرم درخواست در راهنمای نگارش فنی در مرحله درخواست نویسنده فنی موجود است.
پس از ارسال فرم، می توانید به روز رسانی اطلاعات فرم را تا پایان مرحله درخواست نویسنده فنی (9 جولای 2020) ادامه دهید.
اطلاعات شخصی
فرم درخواست اطلاعات شخصی زیر را درخواست می کند:
نام شما: نام کامل خود را وارد کنید. Season of Docs این نام را با سازمان های منبع باز به اشتراک نخواهد گذاشت و این نام را در وب سایت منتشر نخواهد کرد.
نام نمایشی انتخابی شما: نامی را که می‌خواهید در طول شرکت در Season of Docs به عنوان شناسه عمومی استفاده کنید، ارائه دهید. ما قویاً توصیه می کنیم که از نام واقعی و کامل خود برای نام نمایشی خود استفاده نکنید . Season of Docs نام نمایشی شما را با سازمان منبع باز که در فرم درخواست خود مشخص کرده اید به اشتراک می گذارد. Season of Docs نام نمایشی شما را در وب سایت در لیست پروژه های فنی نگارش پذیرفته شده منتشر می کند.
آدرس ایمیل شما: آدرس ایمیل مرتبط با حساب Google خود را ارائه دهید. (شما برای شرکت در Season of Docs به یک حساب Google نیاز دارید. می توانید از یک آدرس ایمیل غیر Gmail با حساب Google استفاده کنید. این مقاله راهنما را ببینید.) Season of Docs از آدرس ایمیل شما برای برقراری ارتباط با شما و ایجاد وب سایت استفاده می کند. منابع در دسترس شما Season of Docs این آدرس ایمیل را با سازمان منبع باز که در فرم درخواست خود مشخص کرده اید به اشتراک می گذارد. Season of Docs این آدرس ایمیل را در وب سایت منتشر نخواهد کرد.
برای خلاصه ای از نحوه استفاده Season of Docs از اطلاعات فرم درخواست شما، به زیر مراجعه کنید.
اطلاعاتی در مورد تجربه نوشتن فنی شما
هنگامی که مربیان منبع باز و مدیران سازمان یک پروژه پیشنهادی را بررسی می کنند، به تجربه نوشتن فنی شما علاقه مند می شوند. شما می توانید جزئیات فرم را به شرح زیر ارائه کنید:
تجربه نگارش فنی اخیر: حداکثر سه ورودی که می‌توانید جدیدترین نقش‌های نوشتاری فنی یا تجربه کاری خود را فهرست کنید. اگر تجربه اسناد منبع باز دارید، آن را در اینجا نیز قرار دهید. نقش خود، مسئولیت های نقش و کاری که انجام داده اید را خلاصه کنید. شما می توانید تاریخ های مربوطه را ارائه دهید.
پیوند به رزومه یا رزومه شما: (اختیاری.) URL نسخه قابل دسترس عموم از رزومه یا رزومه شما (CV).
پیوندی به نمونه‌های کار شما: (اختیاری.) نشانی وب نمونه‌های نوشتاری در دسترس عموم، یا پیوندهای فردی به نمونه‌هایی از کار شما.
هر چیز دیگری که می خواهید اضافه کنید: (اختیاری.) هر اطلاعاتی که می خواهید این برنامه را اضافه کنید. به عنوان مثال، علاقه شما به مستندات فنی، دلیل شرکت در Season of Docs یا سایر تجربیات مرتبط.
پیشنهاد پروژه
پروپوزال پروژه شما خلاصه‌ای از کار مستنداتی است که می‌خواهید هنگام کار با سازمان منبع باز انتخابی خود در طول فصل اسناد تکمیل کنید.
شما می توانید حداکثر سه پیشنهاد پروژه ارسال کنید. تمام پیشنهادات پروژه شما باید در همان فرم درخواست باشد.
با در نظر گرفتن رهنمودهای زیر، برای پروژه پیشنهادی خود وقت بگذارید.
کارهای مقدماتی:
فهرست سازمان‌های منبع باز مشارکت‌کننده را بررسی کنید و یک یا چند سازمان مورد علاقه خود را انتخاب کنید. به ایده های پروژه ای که هر یک از سازمان های منبع باز منتخب شما پیشنهاد داده اند، نگاهی بیندازید.
اگر سازمان مورد علاقه شما هیچ ایده ای را پیشنهاد نکرده است، می توانید لیست کلی ایده های پروژه را بررسی کنید و ایده خود را بر اساس یکی از آنها قرار دهید. شما همچنین می توانید ایده خود را ارائه دهید، چه سازمان ایده هایی ارسال کرده باشد یا نه.
برای بحث در مورد ایده های پروژه با یک یا چند سازمان شرکت کننده در تماس باشید. برای برقراری تماس، از آدرس ایمیل سازمان که در لیست سازمان های شرکت کننده نشان داده شده است استفاده کنید. بحث های اولیه به شما کمک می کند تا یک پیشنهاد پروژه خوب را جمع آوری کنید.
پیشنهاد پروژه شما در فرم درخواست:
نام سازمان منبع باز: نام سازمان منبع باز را که می خواهید در طول فصل اسناد با آن کار کنید، وارد کنید. این باید یکی از سازمان های شرکت کننده باشد که در وب سایت Season of Docs نمایش داده می شود.
نام پروژه منبع باز: این نام پروژه متن باز است که می خواهید در طول فصل اسناد روی آن کار کنید. پروژه باید متعلق به یکی از سازمان های شرکت کننده باشد که در وب سایت Season of Docs نمایش داده شده است. برای برخی از سازمان ها، نام سازمان و نام پروژه ممکن است یکسان باشد.
نام پروژه نگارش فنی پیشنهادی شما. یک عنوان کوتاه و توصیفی ارائه دهید که هدف اصلی کاری را که پیشنهاد می‌کنید خلاصه کند.
شرح مفصل در شرح پروژه نگارش فنی که پیشنهاد می کنید تا حد امکان جزئیات بیشتری ارائه دهید. خوب است که چند پاراگراف را در قسمت توضیحات وارد کنید. در اینجا چند ایده از آنچه باید گنجانده شود وجود دارد:
- جزئیات اسنادی را که برای ایجاد/به‌روزرسانی پیشنهاد می‌کنید، ارائه دهید. اگر قصد دارید یک سند یا سایت موجود را به روز کنید، پیوندی اضافه کنید و به روز رسانی های پیشنهادی را شرح دهید. اگر سند جدید یا سایت جدیدی را پیشنهاد می کنید، محتوا و مخاطبان را توصیف کنید.
- بگویید چرا اسناد جدید یا به‌روزرسانی‌ها را پیشنهاد می‌کنید.
- اگر در مورد پروژه با فردی از سازمان منبع باز بحث کرده اید، خلاصه ای از نتیجه آن بحث ها را درج کنید.
- به زبان و سبک پروپوزال خود توجه کنید. سازمان منبع باز ممکن است از آنها به عنوان عاملی در ارزیابی پیشنهاد استفاده کند.
- پیوندی به توضیحات پروژه خود ارائه ندهید. توضیحات باید شامل تمام جزئیات قطعی پروژه شما باشد. سازمان منبع باز باید بتواند بر اساس محتوای فرم درخواست انتخاب کند نه بر اساس محتوای موجود در جای دیگر. اگر نیاز به پیوند به محتوای دیگری دارید که توضیحات را تکمیل می کند، اشکالی ندارد، اما توجه داشته باشید که فقط محتوای فرم درخواست برای انتخاب پروژه استفاده می شود.
سایر فیلدهای مهم در فرم درخواست
در زیر دستورالعمل هایی در مورد سایر اطلاعات کلیدی که باید در فرم درخواست ارائه کنید آمده است:
انتخاب یک پروژه با طول استاندارد یا طولانی مدت: دوره استاندارد برای مرحله توسعه سند Season of Docs سه ماه است. اگر پروژه شما به مدت زمان طولانی تری نیاز دارد، باید پس از مشورت با سازمان منبع باز انتخابی خود، این را در فرم درخواست ذکر کنید. شرح پروژه های طولانی مدت را ببینید.
پذیرش کمک هزینه Season of Docs: Season of Docs مبلغی پول به آن دسته از نویسندگان فنی می پردازد که پروژه های خود را با موفقیت به پایان برسانند، مشروط بر اینکه نویسنده فنی بخواهد این کمک هزینه را بپذیرد. اطلاعات مربوط به کمک هزینه های نویسنده فنی را ببینید. کمک هزینه اختیاری است. اگر مایل به دریافت کمک هزینه نیستید، انتخاب خود را در فرم درخواست ذکر کنید.
چگونه Season of Docs از اطلاعات فرم درخواست شما استفاده می کند
این بخش نحوه استفاده Season of Docs از اطلاعات فرم درخواست شما را خلاصه می کند. بخش های قبلی این صفحه فیلدهای کلیدی را با جزئیات شرح می دهد.
جدول فیلدهای کلیدی را فهرست می کند. برای هر فیلد، جدول نشان می دهد که آیا Season of Docs:
- اطلاعات را به سازمان منبع باز که در فرم درخواست خود مشخص کرده اید منتقل می کند.
- اطلاعات موجود در لیست پروژه های نگارش فنی پذیرفته شده را در وب سایت Season of Docs منتشر می کند.
| اطلاعات در فرم | با سازمان منبع باز به اشتراک گذاشته شده است؟ | در وب سایت Season of Docs نمایش داده می شود؟ |
|---|---|---|
| نام و نام خانوادگی | ||
| نام نمایشی | ||
| آدرس ایمیل | ||
| تجربه نگارش فنی اخیر | ||
| لینک رزومه یا رزومه | ||
| لینک نمونه کار | ||
| هر چیز دیگری که می خواهید اضافه کنید | ||
| نام سازمان/پروژه منبع باز | ||
| نام و شرح پروژه نگارش فنی | ||
| پروژه طولانی مدت یا استاندارد | ||
| پذیرش کمک هزینه |
کلید نمادهای استفاده شده در جدول بالا:
| سمبل | معنی نماد |
|---|---|
| آره | |
| خیر |
یادداشت
در اینجا چند نکته دیگر را باید در نظر داشت:
ارسال چند پیشنهاد پروژه: شما می توانید بیش از یک طرح پیشنهادی ارسال کنید، اما Season of Docs تنها یک پیشنهاد پروژه را برای هر نویسنده فنی می پذیرد. شما فقط می توانید یک فرم درخواست ارسال کنید. این فرم حداکثر سه پیشنهاد پروژه را امکان پذیر می کند.
تعداد کل پروژه های نگارش فنی در برنامه: Season of Docs فقط می تواند حداکثر تعداد معینی از پروژه های نوشتاری فنی را در کل بپذیرد. نحوه عملکرد تخصیص اسلات را ببینید.
راهنماهای مرتبط
نگاهی به نکاتی برای مربیان در مورد نحوه ارزیابی پیشنهادات نویسنده فنی بیندازید. درک معیارهای انتخاب مربیان به شما کمک می کند تا پیشنهادی را ایجاد کنید که احتمال موفقیت آن بیشتر است.
برای اطلاعات رویه ای درباره زمان و نحوه ارسال درخواست Season of Docs، به راهنمای نگارش فنی مراجعه کنید.