یک توسعه‌دهنده درجه یک رویای من بود – تا زمانی که متوجه شدم می‌توانم اشتیاق خود به نوشتن را با دانش فنی‌ام ترکیب کنم تا امرار معاش کنم. درست است: من در مورد تبدیل شدن به یک نویسنده فنی صحبت می کنم.

و اگر توسعه‌دهنده هستید، ممکن است در موقعیت خوبی برای وارد شدن به نوشتن فنی باشید، اگر این موضوع مورد علاقه شما باشد.

توسعه دهندگان دانش زیادی در مورد موضوعاتی مانند Git، Markdown، زبان های برنامه نویسی و IDE ها دارند که می توانند از آنها برای آموزش دیگران استفاده کنند. و از آنجایی که آنها خودشان با این ابزارها و فناوری‌ها کار کرده‌اند، اغلب می‌توانند مستندات را با رویکرد کاربر محور بنویسند.

همچنین با متوسط ​​دستمزد در ایالات متحده 76432 دلار در سال، نویسنده فنی بودن نسبتاً سودآور است. این باعث می‌شود که شغلی مناسب برای حمایت از خود و خانواده‌تان باشد.

خوشبختانه، زمانی که تصمیم گرفتم به آن فرصت بدهم، نمونه های فنی نوشتاری داشتم تا مهارت های نوشتاری خود را نشان دهم. عشق من به نویسندگی یک نمونه کار آماده برای نوشتن فنی به من پیشنهاد داد و تغییر حرفه ام را آسان تر کرد.

اما این برای همه صدق نمی کند و مردم مرتباً از من نکاتی را برای شروع نوشتن فنی و کسب درآمد از طریق آن می پرسند. پس ، همه چیزهایی را که به من در انتقال به نوشتن فنی کمک کردند را در این مقاله گردآوری می کنم.

نگارش فنی چیست؟

نگارش فنی معمولاً شامل تجزیه دانش فنی پیچیده به کلمات ساده است و درک مفاهیم فنی را برای مخاطبان غیر فنی آسان‌تر می‌کند. هدف از نوشتن فنی این است که اطمینان حاصل شود که کاربران می توانند به طور موثر از یک فناوری استفاده کنند، که در نهایت رضایت کاربر را بهبود می بخشد.

به عنوان یک نویسنده فنی، می توانید در مورد طیف وسیعی از موضوعات بنویسید و برای اهداف و مخاطبان مختلف بنویسید. برخی از انواع نوشتاری که ممکن است انجام دهید عبارتند از:

راهنمای کاربر

مستندات

راهنماهای دقیق

پست های وبلاگ

کاغذهای سفید

SOP ها

و غیره

دقت، سازگاری، وضوح و مختصر بودن برخی از جنبه های مهم نوشتن فنی هستند.

مسئولیت های یک نویسنده فنی چیست؟

نوشتن فنی نیاز به تحقیقات گسترده دارد که می تواند روند نوشتن را طولانی تر کند. نویسندگان فنی برای درک جزئیات فنی محصولات/خدمات مشتری با کارشناسان موضوع (SMEs) در ارتباط هستند.

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

پس از کسب تجربه، نویسندگان فنی ممکن است مجبور شوند نوشته های دیگران را ویرایش و تصحیح کنند. تصحیح و ویرایش نیاز به صبر، توجه به جزئیات و همدلی دارد.

چگونه یک نویسنده فنی شویم

دانش خود را به اشتراک بگذارید

شروع به نوشتن آموزش‌ها، راهنماهای نحوه انجام، و به اشتراک گذاشتن تجربه خود با فناوری در یک پلتفرم انتشار باز مانند Medium، Hashnode یا HackerNoon کنید. کار با این سایت های وبلاگ برای مبتدیان آسان است، زیرا رایگان هستند و برخی از انتشارات آنها پایگاه مخاطبان زیادی دارند.

اگر در مورد نحوه نوشتن مقالات فنی مطمئن نیستید، شروع به خواندن بسیاری از آنها کنید. این به شما این حس را می دهد که چگونه نویسندگان فنی اطلاعات خود را به روشی قابل دسترس به اشتراک می گذارند، چگونه مقالات خود را ساختار می دهند، روی چه موضوعاتی تمرکز می کنند و غیره.

در زیر چند ایده برای پست وبلاگ مبتدی وجود دارد:

نحوه انجام X در / با استفاده از Y (مثال: نحوه ساخت یک وب سایت نمونه کارها در وردپرس)

روش های X برای انجام Y (مثال: 3 روش برای جلوگیری از تطبیق بیش از حد در مدل های یادگیری ماشینی)

آنچه در 10 روز کار با X یاد گرفتم (مثال: آنچه در 10 روز کار در VSCode یاد گرفتم)

راهنمای X: همه چیزهایی که باید بدانید (مثال: راهنمایی برای سازندگان وب سایت هوش مصنوعی: همه چیزهایی که باید بدانید)

همچنین می توانید راهنمای نگارش فنی نشریات مختلف را مطالعه کنید. این ها حاوی نکات و اطلاعات مفید زیادی در مورد نحوه نوشتن آموزش های فنی خوب هستند. Digital Ocean یکی از شناخته‌شده‌ها دارد و freeCodeCamp نیز خود را دارد .

یک نمونه کار بسازید

هنگامی که چند نمونه نوشتاری به دست آوردید، می‌توانید با ایجاد یک نمونه کار آنلاین که شامل تمام نمونه‌های نوشتاری شماست، به اعتبار خود کمک کنید. این چیزی است که می توانید با کارفرمایان بالقوه یا نگهبانان پروژه به اشتراک بگذارید.

می توانید آن را در پلتفرم های رسانه های اجتماعی به اشتراک بگذارید، آن را در بخش ویژه لینکدین نمایش دهید و برای مشتریان بالقوه ارسال کنید.

همچنین می توانید نوشتن برای نشریات را امتحان کنید. نشریات معروف اغلب طرفداران زیادی دارند و محتوای مشارکت کنندگان را در پلتفرم های رسانه های اجتماعی خود به اشتراک می گذارند. این می تواند به ساختن برند شخصی شما به عنوان یک نویسنده فنی کمک کند، شبکه شما را توسعه دهد و به شما انگیزه دهد که مطالب خوب بیشتری بنویسید.

برخی از نشریاتی که مشارکت نویسندگان جدید را می پذیرند عبارتند از:

freeCodeCamp: freeCodeCamp از شما انتظار دارد که حداقل سه نمونه نوشتن در هنگام ارسال یک درخواست مشارکت داشته باشید. روند درخواست کمی سخت تر از برخی است و آنها هر درخواستی را به دلایل مختلف نمی پذیرند. اما اگر از آنها خبری ندارید و بار اول پذیرفته نشدید، تسلیم نشوید. می توانید به بهبود نوشتار خود ادامه دهید و بعداً دوباره امتحان کنید - یا انتشارات دیگر را امتحان کنید. می‌توانید دستورالعمل‌های مشارکت‌کننده fCC را در اینجا بیابید.

Towards Data Science: Towards Data Science مقالات پیرامون علم داده و یادگیری ماشین را می پذیرد. آنها از شما انتظار دارند که مقالاتی با ساختار، جامع و به روز ارسال کنید. دستورالعمل‌های مشارکت‌کننده TDS را اینجا بخوانید.

Level Up Coding: Level Up Coding یک نشریه آنلاین است که بر اشتراک دانش فنی تمرکز دارد تا به مهندسان نرم افزار کمک کند تا یاد بگیرند و رشد کنند. آنها مخاطبانی از توسعه دهندگان، طراحان و دانشمندان داده دارند، پس انتظار دارند محتوایی برای آنها مفید باشد. در اینجا دستورالعمل های کمک کننده برای Level Up Coding آورده شده است.

اگرچه همه نشریات دستورالعمل‌های کمکی برای کمک به مشارکت‌کنندگان در نوشتن نمونه‌های مرتبط دارند، چند نکته برای موفقیت‌آمیز کردن طرح شما عبارتند از:

آشنا شوید: حداقل 3-5 مقاله با عملکرد برتر را در انتشاراتی که می خواهید در آن مشارکت کنید بخوانید. به لحن صدا و سطح جزئیات به اشتراک گذاشته شده برای درک ترجیحات آنها توجه کنید.

ایجاد یک طرح کلی: طرح کلی ساختاری برای محتوای شما است که شما را در مسیر نوشتن در مسیر نگه می دارد. شما می توانید با استفاده از محتوای با عملکرد برتر، ابزارهای هوش مصنوعی و تخصص خود یک طرح کلی خوب ایجاد کنید.

پیش نویس: یک پیش نویس بر اساس طرح کلی خود ایجاد کنید و بگذارید حداقل دو روز بماند. این شکاف به شما کمک می کند تا اشتباهاتی را در پیش نویس خود پیدا کنید که ممکن است در حین یا بلافاصله پس از نوشتن نادیده بگیرید.

پیش نویس خود را ارسال کنید: در نهایت، پیش نویس خود را برای تحلیل به نشریه ارسال کنید. آنها ممکن است پیش نویس شما را ویرایش کنند یا از شما بخواهند قبل از انتشار آن تغییراتی ایجاد کنید. برخی از نشریات نیز از آشکارسازهای محتوای AI استفاده می کنند، پس اگر انتشارات شما از این کار استفاده می کند، مطمئن شوید که محتوای خود را با استفاده از همان آشکارساز هوش مصنوعی تأیید می کنید.

کار خود را به اشتراک بگذارید

در حالی که در حال ساختن مجموعه مقالات فنی خود هستید، می توانید آنها را در لینکدین (و سایر سایت های رسانه های اجتماعی مانند توییتر) به اشتراک بگذارید تا جهان را در مورد مهارت های جدید خود آگاه کنید - و در مورد موضوعات فنی جالب می نویسید.

همچنین می‌توانید پیوندی به نمایه LinkedIn خود در مقالاتی که می‌نویسید، در صورتی که انتشارات اجازه می‌دهد، قرار دهید تا به افراد کمک کنید شما را پیدا کنند. از دیدن اینکه چه تعداد از مردم کار شما را تحسین می کنند شگفت زده خواهید شد و این شما را ادامه خواهد داد. همچنین ممکن است پروژه های پولی و فرصت های شغلی را در DM خود دریافت کنید.

مهارت در نوشتن مستندات

یکی از راه‌های عالی برای تمرین نوشتن فنی (و کمک به دیگران در این راه)، مشارکت در مسائل مستندسازی پروژه‌های منبع باز GitHub است. این مجموعه مهارت های شما را گسترش می دهد و به شما تجربه نوشتن اسناد را می دهد و به شما کمک می کند تا با دستورالعمل های مشارکت کننده بیشتر آشنا شوید.

نوشتن اسناد بیشتر بر روی محصول متمرکز است و برخلاف پست های وبلاگ، معمولاً مختصر است. از یک ساختار از پیش تعریف شده پیروی می کند و قالب محتوا در سراسر صفحات سازگار است. دسترسی، سازگاری، و وضوح بهترین شیوه های عمومی نوشتن اسناد هستند.

برای درک بهتر به پیشنهادات ویراستار توجه کنید. معمولاً دو نوع پیشنهاد ویرایشگر وجود دارد: عینی و ذهنی. پیشنهادات عینی در مورد دستورالعمل های نوشتاری کلی مانند انتقال و وضوح هستند، در حالی که پیشنهادات ذهنی بر لحن و اولویت شرکت متمرکز هستند.

پیشنهادات عینی به شما کمک می کند تا مهارت های نوشتاری خود را بهبود ببخشید و پیشنهادات ذهنی شما را راهنمایی می کنند تا با صدای شرکت هماهنگ شوید.

پروژه های پولی را پیدا کنید

پس از نوشتن محتوای فنی و انجام تحقیق در مورد محتوا، شروع به جستجوی کار پولی کنید. برای مشاغل سطح ابتدایی درخواست دهید یا به دنبال پروژه های آزاد در تابلوهای شغلی و در حلقه خود بگردید. انجام کار واقعی واقعا به پیشرفت سفر نوشتن فنی شما کمک می کند.

اگرچه پلتفرم‌های فریلنسری رقابتی شده‌اند، هنوز هم می‌توانید پروژه‌های پولی را در آنجا پیدا کنید. برندسازی شخصی در ایجاد فرصت های پولی معجزه می کند. نمایه های GitHub و LinkedIn خود را به روز نگه دارید و دستاوردهای خود را در آنجا به اشتراک بگذارید تا مشتریان بالقوه را جذب کنید و از بین دیگر متمایز شوید.

چگونه مهارت های نوشتن فنی را بیاموزیم

شما می توانید دوره های نویسندگی با کیفیت زیادی پیدا کنید، اما پیدا کردن دوره مناسب می تواند مشکل باشد. من چندین دوره آموزشی را گذرانده ام و مایلم با به اشتراک گذاشتن نکات و دوره هایی که ارزش وقت شما را دارند به شما کمک کنم:

The Secret Sauce of Great Writing اثر شانی راجا یک دوره عالی برای مبتدیان است. جنبه‌های اصلی نوشتن خوب را با تمرین‌های تمرینی و مثال‌های فراوان پوشش می‌دهد.

DevRel Uni یک برنامه آنلاین مبتنی بر کوهورت برای افرادی است که به دنبال تغییر به روابط توسعه دهندگان هستند. آنها یک کلاس جداگانه در نوشتن مستندات دارند که در آن کارشناسان رازهای مستندسازی خوب را به اشتراک می گذارند.

هر زمان که اولین پروژه خارجی خود را ایمن کردید، به پیشنهادات ویرایشگر توجه کنید. اگر مقاله مشارکت‌کننده است و فرآیند ویرایش یک به یک را ارائه نمی‌دهند، نسخه ارسالی خود را با مقاله منتشر شده مقایسه کنید. از تغییراتی که انجام داده اند یادداشت بردارید. پیشنهادات ویراستار برای بهتر کردن نوشته شما ارزشمند است و اگر آنها را جدی بگیرید، به زودی شاهد پیشرفت هایی در نوشتار خود خواهید بود.

نتیجه

اگرچه تغییر شغل می تواند هیجان انگیز باشد، انتقال از توسعه به نوشتن فنی چندان دلهره آور نیست. شما فقط باید اضطراب تغییر شغل خود را مدیریت کنید ، یک نمونه کار بسازید، و شروع به پرورش برند شخصی خود برای یک انتقال موفق کنید.

هنوز سوال دارید؟ با خیال راحت با من در لینکدین تماس بگیرید.

خبرکاو