راهنمای نویسنده فنی

فاز فعلی:
برنامه Season of Docs 2020 در 15 مارس 2021 به پایان رسید. جدول زمانی را ببینید.

این صفحه حاوی راهنمای نویسندگان فنی است که در Season of Docs شرکت می کنند.

معرفی

به Season of Docs خوش آمدید! این راهنما مقداری در مورد مشارکت شما در Season of Docs به شما می گوید و به شما در فعالیت هایی که باید در هر مرحله از برنامه انجام دهید کمک می کند.

واجد شرایط بودن برای شرکت در Season of Docs

برای شرکت در Season of Docs به عنوان یک نویسنده فنی، باید:

  • حداقل 18 سال سن در زمان ثبت نام.
  • قادر به نشان دادن تجربیات فنی قبلی با ارائه توضیحات نقش و نمونه کار.
  • واجد شرایط کار در کشور محل اقامت خود در طول مدت برنامه.
  • مقیم کشوری که در حال حاضر توسط ایالات متحده تحریم نشده است. به برنامه های تحریم ها و اطلاعات کشور از خزانه داری ایالات متحده مراجعه کنید.

شرایط کامل نویسنده فنی را ببینید.

مربیان منبع باز شما

مربیان Season of Docs لزوما نویسندگان فنی نیستند و ممکن است تجربه کمی در ارتباطات فنی داشته باشند. آنها اعضای سازمان منبع باز هستند که ارزش اسناد خوب را می دانند و در فرآیندها و ابزارهای منبع باز تجربه دارند.

رابطه بین شما و مربیانتان یک همکاری است. شما تجربه و مهارت های مستندسازی را به سازمان منبع باز می آورید. مربیان شما دانش خود را در مورد منبع باز و کد به اشتراک می گذارند. با هم، می توانید اسناد فنی را توسعه دهید و فرآیندهای پروژه منبع باز را بهبود بخشید.

مراحل اعلام برنامه و درخواست سازمان

تاریخ اعلام Season of Docs 23 مارس 2020 است. سازمان‌های منبع باز علاقه‌مند می‌توانند برای شرکت در Season of Docs بین 13 آوریل 2020 تا 4 مه 2020 درخواست دهند. مدیران برنامه Google فهرست سازمان‌های موفق را در 11 می منتشر می‌کنند. ، 2020.

در فاصله زمانی بین اعلام برنامه و انتشار سازمان های متن باز شرکت کننده، باید مراقب اخبار باشید. می توانید به این وب سایت بازگردید و همچنین پست های وبلاگ یا اخبار دیگر را در وب مشاهده کنید. برخی از سازمان های منبع باز ممکن است ایده های خود را حتی در مرحله درخواست سازمان به اشتراک بگذارند.

ما همچنین از شما دعوت می کنیم تا در مورد Season of Docs و دلیل علاقه مندی خود به این برنامه صحبت کنید. نگاهی به مواد تبلیغاتی برای گرافیک و ایده بیاندازید.

مرحله کاوش نویسنده فنی

مرحله کاوش نویسنده فنی از 11 مه تا 8 ژوئن 2020 اجرا می شود. در این دوره، می توانید فهرست سازمان های شرکت کننده و ایده های پروژه آنها را بررسی کنید. این یک فراخوان آزاد برای نویسندگان فنی است -- برای شروع نیازی به تأیید Season of Docs ندارید. با این حال، شرایط واجد شرایط بودن بالا را در نظر داشته باشید.

وقتی یک یا چند پروژه را پیدا کردید که مورد علاقه شماست، باید مستقیماً به سازمان منبع باز مربوطه مراجعه کنید تا درباره ایده های پروژه بحث کنید.

وظایف شما به عنوان نویسنده فنی در این مرحله

فهرست سازمان‌های منبع باز شرکت‌کننده و ایده‌های پروژه آنها را بررسی کنید.

برای یافتن یک سازمان منبع باز که می خواهید با آن کار کنید، فهرست را بررسی کنید. به پروژه های نگارش فنی که سازمان ها پیشنهاد داده اند نگاه کنید و تصمیم بگیرید که کدام پروژه ها برای شما مناسب است. شما می توانید برای بیش از یک سازمان درخواست دهید. در این مرحله از Season of Docs، ایده خوبی است که بیش از یک گزینه را بررسی کنید. فرآیند انتخاب نهایی تنها یک پروژه را برای هر نویسنده فنی می پذیرد.

مشارکت سازمان های منبع باز

در مورد ایده های پروژه با سازمان های منبع باز بحث کنید.

می توانید ایده های پروژه را با هر یک از سازمان های شرکت کننده در میان بگذارید. برای برقراری تماس، از آدرس ایمیل سازمان که در لیست سازمان های شرکت کننده نشان داده شده است استفاده کنید. بحث‌های اولیه به شما کمک می‌کند تا یک پروژه پیشنهادی خوب برای ارائه به مدیران برنامه Google در مرحله درخواست نویسنده فنی تهیه کنید. ایده های اولیه پروژه ممکن است از فهرست ایده هایی که سازمان پیشنهاد کرده است، باشد. شما نیز می توانید ایده های خود را مطرح کنید.

مشارکت سازمان های منبع باز

ایده هایی برای پروژه های نوشتاری فنی

مرحله درخواست نویسنده فنی

مرحله درخواست نویسنده فنی از 9 ژوئن 2020 تا 9 ژوئیه 2020 اجرا می شود. در این دوره، می توانید برای شرکت در Season of Docs درخواست دهید. مدیران برنامه Google جزئیات مربوطه را از برنامه شما به سازمان منبع باز انتخابی شما ارسال می کنند. سپس مدیران و مربیان سازمان منبع باز پروژه هایی را که می خواهند راهنمایی کنند انتخاب می کنند.

وظایف شما به عنوان متقاضی نویسنده فنی در این مرحله

درخواست خود را برای شرکت در Season of Docs ارسال کنید.

درخواست خود را برای Season of Docs قبل از 9 ژوئیه 2020 ارسال کنید.

ایجاد اپلیکیشن شما

اپلیکیشن‌های نویسنده فنی Season of Docs 2020 اکنون بسته شده‌اند. به لیست پستی اعلامیه در season-of-docs-announce بپیوندید تا در جریان قرار بگیرید.

مرحله پیوند جامعه

مرحله پیوند جامعه از 17 اوت تا 13 سپتامبر 2020 اجرا می شود. در این دوره، مربیان منبع باز به شما کمک می کنند تا با پروژه و جامعه منبع باز آشنا شوید.

وظایف شما به عنوان نویسنده فنی در این مرحله

راه اندازی کانال های ارتباطی

با مربی(های) خود در سازمان منبع باز که برای کار با آن انتخاب کرده اید، تماس بگیرید. اطمینان حاصل کنید که راه مطمئنی برای برقراری ارتباط مستقیم با مربی خود و مدیران سازمان دارید - دومی اعضای سازمان منبع باز هستند که به عنوان مخاطب اصلی Season of Docs برای سازمان خود عمل می کنند.

مسئولیت های شما

مسئولیت های مربیان شما

راهنمای مربیان برای کار با نویسندگان فنی

در پروژه و جامعه منبع باز شرکت کنید.

از مربی خود در مورد ابزارها و فرآیندهایی که سازمان منبع باز استفاده می کند، سؤال کنید. خود را در لیست های پستی، چت، کانال Slack و هر کانال ارتباطی مشترک دیگر جامعه منبع باز معرفی کنید.

درک کاملی از محصول به دست آورید.

از مربی خود بخواهید محصولی را که به زودی مستندسازی می کنید (به ویژه از نظر مفهومی) توضیح دهد. درباره مخاطبان مستندات به تفصیل بحث کنید.

اهداف و انتظارات را تعیین کنید.

با مربی خود کار کنید تا اهداف پروژه نگارش فنی خود را اصلاح کنید و انتظارات را از هر دو طرف تعیین کنید. تعیین این اهداف و انتظارات در حال حاضر راه خوبی برای اطمینان از موفقیت پروژه شما است.

مرحله توسعه Doc

مرحله توسعه سند از 14 سپتامبر 2020 تا 30 نوامبر 2020 اجرا می شود. (تاریخ پایان برای پروژه های طولانی مدت متفاوت است.) در این دوره، شما بر روی پروژه خود با مشورت نزدیک با مربیان خود کار می کنید.

وظایف شما به عنوان نویسنده فنی در این مرحله

برای تکمیل پروژه خود با مربی خود کار کنید.

برای تکمیل پروژه خود از نزدیک با مربی خود همکاری کنید. برای درخواست بازبینی اسناد حاصل و ارسال به‌روزرسانی‌ها به مخزن منبع باز، رویه‌های جامعه منبع باز را دنبال کنید. به عنوان مثال، پروژه های منبع باز میزبانی شده در GitHub با ایجاد یک درخواست کشش برای بررسی و ارسال، فایل ها را اضافه یا به روز می کنند.

هرگونه نگرانی را با مدیر سازمان مطرح کنید.

اگر در مورد ارتباط با مربیان خود نگرانی دارید یا با مشکلات دیگری مواجه شدید که ممکن است بر تکمیل موفقیت آمیز پروژه شما تأثیر بگذارد، به مدیر سازمان منبع باز اطلاع دهید.

مسئولیت های شما

هر نظرسنجی را از مدیران برنامه Google تکمیل کنید.

مدیران برنامه Google ممکن است یک نظرسنجی در اواسط پروژه برای ارزیابی پیشرفت ارسال کنند. نظرسنجی را تکمیل کنید و پاسخ‌های خود را طبق دستورالعمل در سند نظرسنجی به مدیران برنامه Google ارسال کنید.

مرحله نهایی سازی و ارزیابی پروژه

مرحله نهایی‌سازی پروژه از 30 نوامبر تا 5 دسامبر 2020 و مرحله ارزیابی از 3 تا 10 دسامبر 2020 اجرا می‌شود. (تاریخ‌ها برای پروژه‌های طولانی مدت متفاوت است.) در طول دوره نهایی‌سازی پروژه، گزارش پروژه خود را ارسال می‌کنید. ، همچنین محصولات کار نهایی شما نامیده می شود. در طول مرحله ارزیابی، ارزیابی خود را از مربی(های) خود و تجربه خود به عنوان یک شرکت کننده در Season of Docs ارسال می کنید.

وظایف شما به عنوان نویسنده فنی در این مرحله

گزارش پروژه خود را بنویسید

گزارش پروژه خود را بنویسید (گاهی اوقات محصول کار شما نامیده می شود). گزارش پروژه شامل شرح کارهایی است که در طول فصل اسناد انجام داده‌اید و هر پیوند مرتبط.

ایجاد گزارش پروژه شما

فاز نهایی پروژه طولانی مدت بسته شده است.

از مربی خود بخواهید گزارش پروژه شما را بررسی کند.

مربی شما ممکن است بینش ارزشمندی در مورد چگونگی توصیف دستاوردهای شما داشته باشد. همچنین، قبل از اینکه استاد راهنما پروژه را به عنوان پروژه با موفقیت انجام شده یا خیر علامت گذاری کند، به درک مشترک از وضعیت پروژه در این مرحله مفید است.

گزارش پروژه خود را نهایی کنید

گزارش پروژه خود را تا 8 مارس 2021 ساعت 18:00 UTC نهایی کنید. فرم قابل ویرایش است، اما باید نسخه نهایی را تا تاریخ معین ارسال کنید.

فاز نهایی پروژه طولانی مدت بسته شده است.

ارزیابی خود را از مربی و تجربه خود از Season of Docs بنویسید و ارسال کنید.

ارزیابی خود را تا 12 مارس 2021 ساعت 18:00 UTC تکمیل و ارسال کنید.

ارزیابی توسط نویسندگان فنی

مسئولیت های شما

مرحله ارزیابی پروژه های طولانی مدت بسته شده است.

پروژه های طولانی مدت

برای پروژه‌های نوشتاری فنی با طول استاندارد در Season of Docs، مرحله توسعه سند از 14 سپتامبر 2020 تا 30 نوامبر 2020 اجرا می‌شود. با این حال، برخی از نویسندگان فنی ممکن است برای یک پروژه طولانی‌مدت با مشورت سازمان منبع باز درخواست دهند. برای یک پروژه طولانی مدت، مرحله توسعه سند از 14 سپتامبر 2020 تا 1 مارس 2021 اجرا می شود.

دوره نهایی سازی و ارزیابی پروژه برای پروژه های بلندمدت از 1 تا 8 مارس 2021 است.

وظایف و مسئولیت‌های شما همان است که در این صفحه برای پروژه‌های نوشتاری فنی با طول استاندارد توضیح داده شده است، با این تفاوت که تاریخ نهایی شدن پروژه و ارزیابی‌ها دیرتر است.