در سال 2021، به نویسندگی فنی پیوستم، جایی که نزدیک به 20 مقاله فنی پولی نوشتم و بیش از 6 هزار دلار به صورت آنلاین درآمد داشتم.
از تجربه من، نوشتن یک مقاله فنی خوب، پیاده روی در پارک نیست. یک مقاله فنی خوب مقاله ای است که مفاهیم پیچیده را به زبانی ساده و قابل فهم تجزیه کند.
به عنوان یک نویسنده فنی، برای تجزیه مفاهیم پیچیده به زبانی ساده و قابل فهم، باید:
- ابتدا موضوعی که در مورد آن می نویسید را درک کنید.
- دوم، مخاطبی را که برایشان می نویسید بشناسید.
- سوم، بدانید که چگونه یک مقاله را ساختار دهید تا پیام خود را به خواننده خود برسانید.
- در نهایت، بدانید که چگونه از صدا و لحن مناسب در نوشتن خود استفاده کنید.
برای انجام تمام موارد فوق، به یک فرآیند نوشتن فنی خوب نیاز دارید.
در این مقاله، با فرآیند نوشتن فنی که من برای نوشتن مقالات فنی بهتر برای مشتریان خود استفاده می کنم، آشنا خواهید شد.
در اینجا مراحل فرآیند نگارش فنی است که من پوشش خواهم داد:
- مرحله 1: تحقیق
- مرحله 2: برای نوشتن آماده شوید.
- مرحله 3: اولین پیش نویس را بنویسید.
- مرحله 4: مرور
- مرحله 5: ویرایش
- مرحله 6: تایید و انتشار.
مرحله 1: تحقیق
ابتدا موضوعی را که می نویسید در گوگل جستجو کنید و مقالات مرتبط با آن موضوع را مرور کنید. همانطور که مقالات را مرور می کنید، برای درک بهتر موضوع یادداشت برداری کنید.
همچنین، می توانید از ChatGPT در مورد موضوع بپرسید. سپس اطلاعاتی را که از ChatGPT به دست می آورید با اطلاعاتی که از جستجوی گوگل به دست آورده اید مقایسه کنید.
به عنوان مثال، من در این هفته شروع به کار روی یک موضوع جدید برای یک مقاله فنی مشتری کردم. در اینجا یادداشت هایی است که من هنگام تحقیق در مورد موضوع برداشتم.
توجه: باید اطلاعات ChatGPT را با اطلاعات جستجوی Google مقایسه کنید زیرا ChatGPT گاهی اوقات می تواند اطلاعات نادرستی ارائه دهد.
ثانیا، قالب و ساختار موضوعی را که قرار است در مورد آن بنویسید مشخص کنید.
انواع ساختار مقاله
دو نوع مقاله فنی در وبلاگ نویسی فنی وجود دارد.
- مقالات رویه ای: این مقالات خواننده را در انجام یک کار گام به گام راهنمایی می کند.
- مقالات مفهومی: این مقالات به خوانندگان کمک می کند تا موضوع را عمیقاً درک کنند و پایه ای برای یادگیری بیشتر ایجاد کنند.
در زیر ساختارهای مختلف مقالات آورده شده است.
ثالثاً، مخاطبان هدف موضوعی را که در مورد آن می نویسید شناسایی کنید.
ساده ترین راه برای شناسایی مخاطبان هدف، تعیین آنچه مخاطبان شما باید بیاموزند است.
در مقاله فنی که قرار است بنویسید، فهرستی از هر چیزی که مخاطب هدف شما باید بیاموزد، یادداشت کنید.
مرحله 2: برای نوشتن آماده شوید
ابتدا هدف یا هدف مقاله ای را که می نویسید مشخص کنید.
شناسایی مخاطبان خود در مرحله اول به شما در تعیین هدف مقاله کمک می کند.
هدف مقاله می تواند کمک به خواننده در یادگیری چیزی یا حل یک مشکل باشد.
در اینجا نمونه ای از هدف مقاله آورده شده است.
در مرحله دوم، یک طرح کلی مقاله ایجاد کنید.
طرح کلی، به عبارت ساده، اسکلتی از یک نوشته تمام شده است که موضوعاتی را که در یک مقاله پوشش خواهید داد، ترسیم می کند.
طرح کلی ساختاری را فراهم می کند که تضمین می کند ایده های شما به طور منطقی و واضح جریان دارند.
تعیین قالب و ساختار مقاله در مرحله اول به شما کمک می کند تا یک طرح کلی مقاله ایجاد کنید.
به عنوان مثال، در اینجا یک طرح کلی از مقاله ای است که من برای وبلاگ DbVisualizer نوشتم.
توجه: پس از تعیین هدف مقاله و ایجاد طرح کلی، اگر کار مشتری است، می توانید مقاله را برای مشتری ارسال کنید تا بازخورد دریافت کند تا مطمئن شوید که در همان صفحه هستید.
مرحله 3: اولین پیش نویس را بنویسید
ابتدا هدف مقاله را در عنوان بگنجانید. در زیر نحوه قالب بندی یک برچسب آورده شده است،
قالب عنوان
چگونه با <نرم افزار یا فناوری>
مثال
نحوه ایجاد ماشین حساب با جاوا اسکریپت
دوم اینکه شروع به نوشتن مقدمه مقاله کنید. مقدمه هر مقاله باید 1 تا 3 پاراگراف داشته باشد.
سوالاتی که یک معرفی خوب باید به آنها پاسخ دهد
- چه مشکلی در حال رسیدگی است؟
- راهکار برای حل این مشکل چیست؟
- خواننده چه خواهد آموخت؟
ثالثاً پیش نیازها را بنویسید. هدف از پیش نیازها، هجی کردن است دقیقا آنچه که خواننده باید قبل از دنبال کردن آموزش فعلی داشته باشد یا انجام دهد.
قالب فهرستی است که خواننده می تواند از آن به عنوان چک لیست استفاده کند. هر نقطه باید به یک آموزش موجود مرتبط باشد که محتوای لازم یا اسناد رسمی نرم افزار را پوشش می دهد.
این به شما امکان می‌دهد به جای شروع از ابتدا به محتوای موجود که کار می‌کند تکیه کنید.
چهارم شروع به نوشتن متن مقاله به صورت مرحله ای کنید. مراحل بخش هایی از مقاله شما هستند که در آن توضیح می دهید که خواننده باید چه کاری انجام دهد و چرا.
یک مرحله شامل دستورات، فهرست کدها و فایل هایی است که توضیح می دهند چه باید کرد و چرا اینجوری انجامش میدی
در آخر، نتیجه گیری مقاله را بنویسید. نتیجه‌گیری مقاله باید آنچه را که خواننده با دنبال کردن آموزش شما آموخته یا انجام داده است، خلاصه کند.
مرحله 4: بررسی پیش نویس اول
پس از نوشتن اولین پیش نویس، آن را برای مشتری، کارشناس موضوع یا فردی که اطلاعات خوبی از موضوعی که در مورد آن می نویسید، ارسال کنید تا بررسی شود.
بررسی پیش نویس توسط مشتری یا کارشناس موضوع تضمین می کند که مقاله از نظر فنی دقیق است و هدف مقاله را برآورده می کند.
مرحله 5: ویرایش و بازبینی
ویرایش و بازنگری جایی است که پیش نویس بررسی شده را به یک پیش نویس نهایی تبدیل می کنید. اطمینان حاصل کنید که بین نوشتن و ویرایش استراحت کنید. استراحت به شما این امکان را می دهد که کار خود را با چشمانی تازه ببینید.
می‌توانید از ابزارهایی مانند Grammarly در فرآیند ویرایش برای بررسی اشتباهات املایی، دستور زبان، سبک و نقطه‌گذاری استفاده کنید.
مرحله 6: تصحیح و تایید پیش نویس نهایی
تصحیح پیش نویس نهایی زمانی است که شما نوشته خود را به پایان رسانده اید اما آماده انتشار آن نیستید یا برای تایید به مشتری خود تحویل می دهید.
در اینجا شما مقاله خود را مرور می کنید تا متوجه شوید:
- هر گونه غلط املایی
- اشتباهات گرامری
- غلط املایی
- خطاهای قالب بندی
- ساختار یا نحو نادرست
پس از تصحیح پیش نویس نهایی، آن را برای آخرین بررسی و تایید برای مشتری ارسال کنید.
مرحله 7: مقاله تمام شده را منتشر کنید
اگر تغییرات بیشتری در پیش نویس نهایی ایجاد نشود، مشتری مقاله را منتشر می کند. اگر این یک مقاله شخصی است، می توانید آن را در وبلاگ خود یا پلتفرم های وبلاگ نویسی رایگان برای توسعه دهندگانی مانند:
نتیجه
نحوه نوشتن یک مقاله فنی خوب را به صورت گام به گام در این مقاله یاد گرفته اید. اگر مقاله را دوست داشتید، برای نکات روزانه در مورد نوشتن فنی، من را در توییتر دنبال کنید.
