فاز فعلی:
برنامه Season of Docs 2020 در 15 مارس 2021 به پایان رسید. جدول زمانی را ببینید.
در اینجا چند دستورالعمل برای سازمان های منبع باز در مورد نحوه کار با یک نویسنده فنی که برای Season of Docs راهنمایی می کنید آورده شده است:
- نویسنده فنی را به دنیای متن باز و جامعه خود معرفی کنید.
- به نویسنده فنی کمک کنید از ابزارها و فرآیندهای مربوط به مشارکت در پروژه شما استفاده کند.
- محصول خود را با جزئیات توضیح دهید تا نویسنده فنی به درک مفهومی محکمی از محصول دست یابد. این می تواند به نویسنده فنی کمک کند که اعتماد به نفس بیشتری داشته باشد و در نوشتن خود برای پروژه معتبرتر باشد.
- نیازهای مخاطبان خود را توصیف کنید—یعنی نیازهای توسعه دهندگانی که از محصول شما استفاده می کنند و/یا سایر گروه هایی که از محصول استفاده می کنند.
- موارد استفاده مهم را با نویسنده فنی کارگاه کنید تا به آنها در طراحی مستندات مورد نیاز کمک کنید.
- زمانی که نویسنده فنی نیاز به درک آن قبل از نوشتن اسناد دارد، کد را مرور کنید.
- نویسنده فنی را با کارشناسان موضوع مورد نیاز در تماس قرار دهید. یعنی توسعه دهندگان یا سایر مشارکت کنندگان پروژه مسئول جنبه هایی از محصول شما هستند که مستندات پوشش می دهد.
- اطمینان حاصل کنید که نویسنده فنی زمان و منابع مورد نیاز خود را از کارشناسان موضوع و سایر اعضای جامعه دریافت می کند.
- با نویسنده فنی کار کنید تا در صورت لزوم، نمونه کدهای معنادار را به اسناد اضافه کنید.
چیزهایی که باید در نظر داشت
مربیان متن باز در Season of Docs لزوما نویسندگان فنی نیستند. مربیان نیازی به داشتن مهارت های مستندسازی ندارند. نویسندگان فنی این مهارت ها را به پروژه و رابطه مربیگری می آورند.
در عوض، مربیان دانش خود را از جامعه منبع باز، محصول، و فرآیندها و ابزارهایی که پروژه منبع باز استفاده می کند، به ارمغان می آورند.
یک نتیجه مهم از رابطه مربیگری باید این باشد که نویسنده فنی تجربه موفق و مفیدی در فصل مستندات امسال داشته باشد. یک تجربه خوشحال کننده این شانس را افزایش می دهد که نویسنده فنی پس از پایان فصل اسناد سال جاری به مشارکت در پروژه منبع باز ادامه دهد و سایر نویسندگان فنی برای کار در منبع باز مشتاق شوند.
اطلاعات مربوطه
- مسئولیت های مدیران و مربیان سازمان و نویسندگان فنی .
- راهنمای مربی .