یادداشتهای مطالعه
Writing for Software Developers درباره تبدیل دانش مهندسی به نوشته عمومی مفید است.
عملی است چون نوشتن را workflow حرفهای میداند: موضوع انتخاب کن، خواننده را بفهم، outline بساز، draft بزن، ویرایش کن، منتشر کن و از واکنش یاد بگیر. به کار مهندسی نزدیک است؛ برای همین توصیهها قابلاجرا میشوند.
ایدههای مفید
developerها با قصد میخوانند
خواننده فنی معمولاً با یک مسئله میآید. skim میکند، جستجو میکند، کپی میکند، تست میکند و بعد برمیگردد. مقاله خوب با ساختار، مثال، heading روشن و prerequisite صادقانه به این رفتار احترام میگذارد.
مدل خواننده مهم است
قبل از نوشتن مشخص کن برای چه کسی است و چه چیزی میداند. آموزش برای مبتدی، راهنمای migration برای engineer در حال کار و deep dive برای maintainer ریتم و نوع اثبات متفاوت میخواهند.
انتشار بخشی از کار است
کتاب در نوشتن متوقف نمیشود. pitching، ویرایش، توزیع و جنبه کسبوکاری محتوای فنی را هم پوشش میدهد. برای engineerهایی مفید است که میخواهند نوشتن بخش پایدار مسیرشان شود.
چرا نزدیک نگهش میدارم
راهنمای مفید برای تبدیل تجربه پیادهسازی به مقالههایی که به developer دیگر کمک میکنند، نه فقط ثبت آنچه اتفاق افتاد.
دریافت کتاب
- سایت رسمی: Writing for Software Developers