دروس بسیاری از دوران حضورم در دانشگاه در طول سالها با من همراه بوده است. یکی از مهمترین موارد مربوط به نگارش فنی بود (با تشکر از استاد CS 787 من)
این درس این است که روند نوشتن تکنیکال معطوف به بودن است روشن و مختصر. هر جنبه از این کار فنی ، چه بصری و چه متنی ، باید بدون اضافه کاری یا محتوای نامرتبط باشد.
این بدان معنی نیست که نوشتن شما نباید پیچیده یا خسته کننده باشد ، بلکه فقط به این معنی است که باید اطلاعات مربوطه را منتقل کنید. به عبارت دیگر، برو سر اصل مطلب.
داستان من
بنابراین این کار من را به README که روی آن کار کرده ام می رساند. من یک repo دارم که می خواستم بیشتر مورد توجه کاربران بالقوه قرار بگیرم. این یک وضعیت معمول است که بسیاری از توسعه دهندگان متن باز در آن قرار می گیرند. من تجربه نوشتن README های با کیفیت بالا را زیاد نداشتم.
در طول سالها استفاده از GitHub ، من README های بسیار جذاب با سبک های منحصر به فرد و تصاویر / انیمیشن های دیوانه دیده ام ، اما اکنون لزوماً فکر نمی کنم که این همیشه موثرترین راه برای بهبود README شما باشد.
هفته گذشته من در زیرمجموعه های مختلف مربوط به برنامه نویسی چیزی را در امتداد عنوان “به دنبال راهنمایی / انتقاد درباره Github README خود هستم؟” ، در کل 5 مورد ارسال کردم. بعلاوه ، من چند توسعه دهنده منبع باز مجرب را DMed کردم.
طی 48 ساعت بعد ، من …