فاز فعلی:
نهایی شدن پروژه جدول زمانی را ببینید.
این صفحه برای سازمان های منبع باز در مرحله اکتشاف فرآیند درخواست سازمان است. این ایدههای پروژه تنها نمونههایی هستند برای نشان دادن اینکه چگونه سازمانها ممکن است پروژههای مستندسازی ممکن را در صفحه ایدههای پروژه سازمان توصیف کنند. سازمان ها می توانند پروژه هایی را پیشنهاد دهند که در این لیست گنجانده نشده اند.
ایده پروژه: یک راهنمای ورود مشارکت کننده ایجاد کنید
مشکل
- مشارکتکنندگان جدید نمیتوانند اطلاعات راهاندازی مورد نیاز خود را برای مشارکت معنادار در پروژه ما پیدا کنند. برخی از فرآیندها (مانند مشارکت در آزمایشات ما) اصلاً مستند نیستند.
چگونه موفقیت را اندازه گیری کنیم؟
- افزایش تعداد مشارکت کنندگان جدید
- افزایش تعداد مشارکتکنندگان جدید بدون کد (با تسهیل مشارکت در اسناد یا آزمایشها)
- کاهش تعداد مسائل مطرح شده توسط مشارکت کنندگان جدید
- افزایش تعداد شماره های بسته شده با برچسب "اولین شماره خوب"
یک نویسنده فنی برای کار روی این پروژه به چه مهارت هایی نیاز دارد؟
- باید: آشنایی با GitHub (یا تمایل به کار از طریق آموزش های GitHub)
- خوب است: آشنایی با دونده آزمایشی ما، به منظور اجرای تست های ما و به روز رسانی اسناد برای انجام این کار
داوطلبان
اعضای انجمن را تشویق کنید تا برای کمک به کارهای خاص ثبت نام کنند، به عنوان مثال:
- @JaneQDev، می تواند در پاسخ به سؤالات مربوط به آزمون های ما کمک کند
- @ChenPCoder، از بررسی درخواستهای کشش اسناد خوشحالم
- @ErichJEngineer، میتواند در فرآیند مشارکت فعلی با نویسنده فنی قدم بگذارد
اطلاعات تماس
- نویسندگان فنی علاقه مند به کار بر روی این پروژه باید یک ایمیل به ایمیل@project ارسال کنند. پیوندهایی به کار نوشتاری فنی یا نمونه کارها / رزومه / CV خود اضافه کنید.
ایده پروژه: نوشتن آموزش برای استفاده از کتابخانه ما با ...
مشکل
- پروژه ما مشکلات زیادی را توسط کاربرانی که سعی میکنند از کتابخانه ما با $TechnologyX استفاده کنند، مطرح میکند. ما راهنمای روشنی برای ادغام با $TechnologyX نداریم و ممکن است مشکل باشد!
چگونه موفقیت را اندازه گیری کنیم؟
- کاهش تعداد مسائل دارای برچسب "$TechnologyX"
- افزایش تعداد درخواستهای کشش از سوی مشارکتکنندگان جدید که به ما کمک میکند تا اشکالات را برطرف کنیم یا به اسناد پیرامون $TechnologyX اضافه کنیم.
- پیوندهای بیشتر به پروژه ما از پروژه های $TechnologyX
یک نویسنده فنی برای کار روی این پروژه به چه مهارت هایی نیاز دارد؟
- خوب است: آشنایی با $TechnologyX
داوطلبان
اعضای انجمن را تشویق کنید تا برای کمک به کارهای خاص ثبت نام کنند، به عنوان مثال:
- @JaneQDev، می تواند در پاسخ به سوالات مربوط به $TechnologyX کمک کند
- @ChenPCoder، از بررسی درخواستهای کشش اسناد خوشحالم
اطلاعات تماس
- نویسندگان فنی علاقه مند به کار بر روی این پروژه باید یک ایمیل به ایمیل@project ارسال کنند. پیوندهایی به کار نوشتاری فنی یا نمونه کارها / رزومه / CV خود اضافه کنید.
ایده پروژه: اسناد خود را سازماندهی مجدد کنیم
مشکل
- اسناد ما گسترده و بی نظم است. بسیاری از کاربران از تلاش برای یافتن پاسخ در مستندات صرف نظر می کنند و به جای آن فقط در انجمن های ما مسائلی را مطرح می کنند یا سؤال می پرسند. صفحات ما حتی برای کلمات کلیدی مرتبط در نتایج جستجو ظاهر نمی شوند.
چگونه موفقیت را اندازه گیری کنیم؟
- سئوی بهتر برای اسناد ما
- کاهش تعداد موضوعات مطرح شده برای موضوعات تحت پوشش در اسناد
- افزایش تعداد مشارکت در اسناد
یک نویسنده فنی برای کار روی این پروژه به چه مهارت هایی نیاز دارد؟
- خوب است: تجربه سازماندهی مجدد مجموعه های اسناد بزرگ و بالغ، درک SEO
داوطلبان
اعضای انجمن را تشویق کنید تا برای کمک به کارهای خاص ثبت نام کنند، به عنوان مثال:
- @ChenPCoder، از بررسی درخواستهای کشش اسناد خوشحالم
اطلاعات تماس
- نویسندگان فنی علاقه مند به کار بر روی این پروژه باید یک ایمیل به ایمیل@project ارسال کنند. پیوندهایی به کار نوشتاری فنی یا نمونه کارها / رزومه / CV خود اضافه کنید.
ایده پروژه: یک تعمیر مستندات را اجرا کنید
مشکل
- ما بسیاری از اشکالات کوچک و مسائل قدیمی مربوط به مستندات خود داریم. جامعه ما خوشحال خواهد شد که وارد کار شود و به تمیز کردن آن کمک کند، اما ما به کسی نیاز داریم که تعمیرات واقعی را سازماندهی و اجرا کند.
چگونه موفقیت را اندازه گیری کنیم؟
- تعداد مسائل مربوط به اسناد بسته شده است
- افزایش تعداد مشارکتهای اسناد و مشارکتکنندگان جدید
یک نویسنده فنی برای کار روی این پروژه به چه مهارت هایی نیاز دارد؟
- خوب است: تجربه اجرای یک تعمیر اسناد
- مهارت های سازمانی عالی
داوطلبان
اعضای انجمن را تشویق کنید تا برای کمک به کارهای خاص ثبت نام کنند، به عنوان مثال:
- @ChenPCoder، می تواند به سازماندهی ویدیو و چت برای رفع مشکل کمک کند و به یافتن داوطلبان در مناطق زمانی دیگر کمک کند.
اطلاعات تماس
- نویسندگان فنی علاقه مند به کار بر روی این پروژه باید یک ایمیل به email@project/یک موضوع را باز کنند یا در انجمن ما بپرسند. پیوندهایی به کار نوشتاری فنی یا نمونه کارها / رزومه / CV خود اضافه کنید.
ایده پروژه: یک ممیزی مستندات انجام دهید
مشکل
- ما ایده خوبی از وضعیت اسناد خود نداریم! اولویتبندی بهبود اسناد دشوار است، زیرا ما نقشه راه یا احساسی از فوریترین مشکلات نداریم. ما همچنین محتوای قدیمی زیادی داریم که باید حذف یا بایگانی شوند.
چگونه موفقیت را اندازه گیری کنیم؟
- ایجاد نقشه راه مستندسازی با تایید عمومی جامعه
- کاهش تعداد صفحات اسناد قدیمی یا نادرست
یک نویسنده فنی برای کار روی این پروژه به چه مهارت هایی نیاز دارد؟
- خوب است: تجربه انجام ممیزی اسناد
داوطلبان
اعضای انجمن را تشویق کنید تا برای کمک به کارهای خاص ثبت نام کنند، به عنوان مثال:
- @JaneQCoder، می تواند به هماهنگی ارائه نقشه راه مستندات در جلسه انجمن ما کمک کند
اطلاعات تماس
- نویسندگان فنی علاقه مند به کار بر روی این پروژه باید یک ایمیل به email@project/یک موضوع را باز کنند یا در انجمن ما بپرسند. پیوندهایی به کار نوشتاری فنی یا نمونه کارها / رزومه / CV خود اضافه کنید.
اطلاعات مرتبط
- صفحه تبلیغات و مطبوعات شامل لوگوها و سایر مطالبی است که می توانید هنگام صحبت در مورد فصل اسناد Google از آنها استفاده کنید.
- این ویدیو از PyCon استرالیا 2017 نکاتی را در مورد سازماندهی مستندات شما به طوری که مردم آن را مفید بدانند، ارائه می دهد: آنچه که هیچ کس در مورد مستندات توسط دانیل پروسیدا به شما نمی گوید .