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

فاز فعلی:
نهایی شدن پروژه جدول زمانی را ببینید.

در اینجا چند دستورالعمل برای کمک به سازمان های منبع باز وجود دارد که به طور موثر با نویسندگان فنی کار کنند.

نویسنده فنی را به دنیای متن باز و جامعه خود معرفی کنید

  • به نویسنده فنی یک «گشت با راهنما» در جامعه خود بدهید. کجا می توانند سوال بپرسند؟ آنها باید در چه جلسات منظمی شرکت کنند یا به چه لیست های پستی بپیوندند؟ آنها به چه حساب هایی نیاز دارند (Github، Discord، Slack)؟ مطمئن شوید که قوانین رفتاری پروژه شما را درک می کنند و می دانند که چگونه مشکلات را گزارش کنند. اطمینان حاصل کنید که نویسنده فنی شما مجوز پروژه شما را درک می کند و با هر گونه الزامات سایر کارفرمایان در مورد امضای CLA، DCO یا سایر قراردادها مطابقت دارد.
  • در صورت امکان، آنها را به چند نفر در مناطق زمانی همپوشانی معرفی کنید که می توانند به سؤالات مربوط به انجمن یا پروژه به سرعت پاسخ دهند.
  • اگر می توانید، برای آنها یک پروژه سوآپ بفرستید!

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

  • اگر فرآیندهای شما به خوبی مستند نشده است، زمانی را تعیین کنید تا نویسنده فنی در اولین مشارکت، مشکل یا درخواست درخواستی خود بگذرد. از چه قالب ها یا برچسب هایی باید استفاده کنند؟ چه کسی باید مشارکت خود را بررسی کند و چگونه و چه زمانی باید بررسی ها را پیگیری کند؟ اگر کار آنها شامل نمونه کد باشد، چگونه می توان آنها را آزمایش کرد؟ آنها باید در مورد فرآیند یا نسخه های CI/CD شما بدانند؟

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

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

سوال بپرس!

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