ایده های پروژه

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

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

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

پروژه های نمونه

در زیر چند ایده از نوع پروژه ای وجود دارد که یک نویسنده فنی می تواند به آن رسیدگی کند:

  • یک سایت مستندسازی بر روی یک پلتفرم بسازید که باید توسط نویسنده فنی و مربی منبع باز تصمیم گیری شود و مجموعه اولیه اسناد اولیه را در سایت منتشر کنید. نمونه هایی از پلتفرم ها عبارتند از:

  • اسناد موجود پروژه منبع باز را اصلاح کنید تا تجربه کاربری بهبودیافته یا معماری اطلاعات در دسترس تری را ارائه دهید.

  • یک نمای کلی مفهومی یا مقدمه ای برای یک محصول یا ویژگی بنویسید. اغلب یک تیم مستندات فنی خود را از پایین به بالا ایجاد می کند، در نتیجه جزئیات زیادی وجود دارد اما درک محصول به عنوان یک کل دشوار است. یک نویسنده فنی می تواند این را برطرف کند.

  • یک آموزش برای یک مورد استفاده با مشخصات بالا ایجاد کنید.

  • مجموعه ای از راهنماهای متمرکز برای کارهای خاص ایجاد کنید.

  • یک راهنمای مشارکت‌کننده ایجاد کنید که شامل اطلاعات اولیه درباره شروع به‌عنوان مشارکت‌کننده در پروژه منبع باز، و همچنین قوانین مربوط به توافق‌نامه‌های مجوز، فرآیندهای درخواست‌ها و بررسی‌ها، ساخت پروژه و غیره باشد.

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

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

لیست ایده های پروژه خود را منتشر کنید

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

صفحه ایده های پروژه شما باید شامل موارد زیر باشد:

  • اطلاعات مربوط به سازمان منبع باز شما:

    • نام سازمان.
    • شرح سازمان
    • پیوندی به مخزن منبع باز و/یا وب سایت شما.
    • (اختیاری) یک آدرس ایمیل برای تماس با سازمان خود در مورد Season of Docs. این باید همان آدرس ایمیلی باشد که در فرم درخواست سازمان خود برای Season of Docs درج می کنید.
    • (اختیاری) اطلاعات مربوط به مدیریت سازمان و مربیان شما، مانند نام نمایشی آنها. این نام‌ها باید مانند نام‌های نمایشی باشد که در فرم درخواست سازمان خود برای Season of Docs درج می‌کنید.

  • اعلامیه ای مبنی بر اینکه سازمان شما برای شرکت در فصل اسناد امسال درخواست داده است. صفحه تبلیغات و مطبوعات شامل آرم‌ها و سایر مطالبی است که می‌توانید هنگام صحبت در مورد Season of Docs از آنها استفاده کنید.

  • ایده(های) پروژه شما، از جمله اطلاعاتی که در زیر برای هر ایده پروژه توضیح داده شده است.

هنگامی که برنامه سازمان خود را برای Season of Docs ایجاد می کنید، باید پیوندی به صفحه ایده های پروژه خود اضافه کنید.

اطلاعات در هر ایده پروژه

هر ایده پروژه باید حداقل شامل اطلاعات زیر باشد:

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

  • مطالب مرتبط:

    • پیوند به پروژه منبع باز که نیاز به مستندات دارد.
    • اگر یک پروژه نگارش فنی را پیشنهاد می‌کنید که شامل به‌روزرسانی‌های مجموعه اسناد موجود است، به آن مجموعه مستندات پیوند دهید.
    • اگر یک آموزش یا مجموعه ای از راهنماهای نحوه ارائه پیشنهاد می کنید، ویژگی ها یا مواردی را که نیاز به مستندسازی دارند را شرح دهید.
    • اگر راهنمای مشارکت‌کننده را پیشنهاد می‌کنید، به هر فایل README موجود یا سایر مطالب مرتبط در صورت وجود پیوند دهید. اگر هنوز چیزی در دسترس نیست، گفتن آن خوب است.
    • در صورت لزوم، پیوندهایی به اسناد مشابه در پروژه‌های دیگر اضافه کنید.

اهمیت ایده های پروژه

ایده های پروژه شما از چند جهت مهم هستند:

  • کار بر روی ایده ها به سازمان شما کمک می کند تا وظایف مستندسازی مورد نیاز را تدوین کند و برای کار با یک نویسنده فنی آماده شود.
  • ایده‌های پروژه به مدیران برنامه Google نشانی از نوع کاری می‌دهد که یک نویسنده فنی وقتی وارد یک رابطه راهنمایی با سازمان شما می‌شود. مدیران برنامه Google از ایده های پروژه برای قضاوت در مورد تعهد سازمان به مشارکت در Season of Docs و راهنمایی یک نویسنده فنی در طول برنامه استفاده می کنند.
  • ایده های پروژه، نویسندگان فنی علاقه مند را به سازمان شما جذب می کند. آنها می توانند از پروژه های پیشنهادی شما به عنوان مبنایی برای طرح های پیشنهادی خود استفاده کنند.