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

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

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

نویسندگان فنی چه ویژگی‌هایی باید داشته باشند؟

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

در ادامه پنج مهارت اساسی که باید روی آن‌ها کار کنید تا بتوانید یک نویسنده فنی موفق شوید، ارائه شده است:

نحوه نوشتن را یاد بگیرید

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

کارهای زیر به شما کمک خواهد کرد تا بتوانید در نوشتن پیشرفت کنید:

• دستور زبان و قوانین زبان مورد‌نظر را یاد بگیرید.
• استفاده از مثال‌ها را در نوشتن دست‌کم نگیرید.
• بیشتر بخوانید! خواندن به شما کمک می‌کند تا دایره واژگان خود را گسترش دهید.
• از همه مهم‌تر، تا می‌توانید از زبان مورد‌نظر استفاده کرده و بنویسید.

مخاطب خود را بشناسید

شناسایی مخاطبان و شخصی‌سازی محتوا برای آن‌ها باعث برجسته شدن مقالات یا مستندات شما می‌شود. به همین دلیل است که شما باید مخاطبان خود را بشناسید. وقتی مخاطب را بشناسید‌، می‌توانید مقاله خود را متناسب با نیازهای آن‌ها تنظیم و طبیعتاً منظور خود را به شکل مؤثرتری منتقل کنید.

اما چگونه می‌توانید مخاطبان خود را شناسایی کنید؟

• درباره خوانندگان هدف از خود سؤال بپرسید

قبل از شروع به نوشتن مقاله، باید از خود سؤالاتی از این قبیل بپرسید:

• خوانندگان من چه کسانی هستند؟
• چرا این مقاله را می‌خوانند؟
• و چه انتظاری از آن دارند؟

وقتی جواب این سؤالات را بدانید، می‌توانید مخاطبان، نیاز‌ها و خواسته‌های آن‌ها را شناسایی و متن را به بهترین شکل برای آن‌ها طراحی کنید.

• از اصطلاحات مناسب استفاده کنید

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

• عنوان درستی به مقاله خود بدهید

به مقالات خود نامی توصیفی و مرتبط بدهید. به‌عنوان مثال، اگر مطلبی که مربوط به رندر کردن المنت‌ها در React است را «همه چیز درباره‌ی React» نام‌گذاری کنید، خوانندگان را که انتظار داشتند بعد از خواندن مقاله شما همه چیز را در‌مورد React بدانند، نا‌امید خواهید کرد. بنابراین عنوانی را به مقالات خود بدهید که دقیقاً همان چیزی را که در مقاله خود نوشته‌اید،  توصیف می‌کند.

مهارت‌های فنی خود را توسعه دهید

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

تحقیق کنید

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

چگونه باید پژوهش‌های خود را پیش ببرید؟

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

در جستجوی اینترنتی، سؤالاتی  را هدف قرار دهید که می‌خواهید یاد بگیرید. به‌عنوان مثال، اگر می‌خواهید در‌مورد نحوه استفاده از GSAP ScrollTrigger Plugin در React بیاموزید، سؤال شما باید از این قالب “How can I use GSAP ScrollTrigger Plugin in React” پیروی کند.

اگر تصمیم دارید از فردی آگاه در‌مورد موضوع مورد‌نظر سؤال بپرسید، ضمن رعایت ادب، مستقیماً به اصل مطلب بپردازید. پیام شما به آن‌ها باید مهمترین موارد را در‌برگیرد: نام شما‌، تحسین شما از کارشان‌، آنچه می‌خواهید از آن‌ها یاد بگیرید و اینکه می‌فهمید اگر وقتی برای پاسخگویی به سؤال شما بگذارند، لطف بزرگی به شما کرده‌اند.

همچنین می‌توانید از یک کتاب مرتبط برای یافتن پاسخ سؤال‌های خود استفاده کنید.

منحصر‌به‌فرد بیان کنید

آیا تا‌به‌حال فکر کرده‌اید که چرا افراد برای مقالات، کامنت‌هایی از‌قبیل «من بالاخره به لطف مقاله شما این مفهوم را فهمیدم» یا «من مقالات بسیاری را خوانده بودم، اما فقط زمانی که مطلب شما را خواندم، این مفهوم را درک کردم. متشکرم!» می‌گذارند؟ اگر از من بپرسید، می‌گویم آن‌ها به‌نوعی توانسته‌اند با طرز بیان نویسنده ارتباط برقرار کنند و این یعنی هر‌کس بیان مخصوص به خودش را دارد. بنابراین اگر دو توسعه‌دهنده در‌مورد یک موضوع بنویسند، برخی از خوانندگان، مقاله اول را بیشتر می‌فهمند. در حالی‌که برخی دیگر مقاله دوم را بیشتر از مقاله اول درک می‌کنند و این به این دلیل است که هر دوی نویسندگان طرز بیان خودشان را دارند که ممکن است برای برخی افراد کارساز و برای برخی دیگر نباشد.

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

مطلب مشابه: نویسندگی؛ مهارتی دست‌کم‌گرفته‌شده در مهندسی نرم‌افزار

چگونه می‌توان نویسنده فنی شد

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

بیایید در‌مورد چهار کار مهمی که برای تبدیل شدن به یک نویسنده فنی باید انجام دهید، صحبت کنیم.

یک دوره نوشتن مقاله فنی را بگذرانید

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

 از‌این‌رو دوره‌هایی مانند Technical Writing Courses مهارت نگارش فنی شما را به‌طرز قابل‌توجهی ارتقا خواهند داد.

کتاب و مقالات فنی بخوانید

لیزا سی می‌گوید: «هزار کتاب بخوان و آنگاه حرفهایت مثل رودخانه جاری خواهند شد.» خواندن به شما کمک می‌کند تا بتوانید واژگان خود را غنی کنید و آنچه را که در دنیای نوشتن می‌گذرد، کشف کنید. همچنین شما را در جریان آخرین الگو‌ها و ترند‌ها قرار می‌دهد. از‌این‌رو توصیه می‌شود مقالات مرتبط با فناوری را از سایت‌هایی مانند FreeCodeCamp ،Hashnode و The Writing Cooperative بخوانید.

شروع به نوشتن کنید

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

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

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

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

ثابت‌قدم بمانید

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

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

یک ایده بسیار خوب برای تمرین و استمرار در نوشتن این است که چالش «2 مقاله 1 هفته» 2Articles1Week Writing Challenge# را امتحان کنید.

چالش «2 مقاله 1 هفته» چیست؟

هدف از این چالش تشویق نویسندگان فنی برای تعریف اهداف، درک استانداردهای نوشتن و از همه مهمتر استمرار در نوشتن است. در این چالش، شرکت‌کنندگان حداقل 2 مقاله در هفته و به مدت 4 هفته در بلاگ خود منتشر می‌کنند. اگر این کار را انجام دهید، فقط در مدت یک ماه می‌توانید 8 مقاله در بلاگ خود ایجاد و منتشر کنید. شرکت در این چالش مزایای بسیاری دارد و به شما کمک می‌کند تا به‌طور مداوم بنویسید.

در پروژه‌های متن‌باز مشارکت کنید

بدون شک مستندات پروژه‌های متن‌باز به اندازه خود نرم‌افزار مهم است. بنابراین اگر نویسنده فنی هستید، می‌توانید در چنین پروژه‌هایی مشارکت کنید. ممکن است به‌صورت رایگان روی یک پروژه یا یک سازمان متن‌باز کار کنید، اما مشارکت‌های متن‌باز به شما کمک می‌کنند تا مهارت‌های نوشتن خود را ارتقا دهید، شبکه ارتباطات خود را گسترش دهید و بتوانید از آن‌ها توصیه‌نامه‌های خوبی بگیرید. همچنین این کار شانس شما را در گرفتن پذیرش در برنامه Season of Docs افزایش می‌دهد.

 Google Season of Docs چیست و چرا مهم است؟

Season of Docs یک برنامه سالانه است که توسط Google سازمان‌دهی می‌شود. هدف آن گردآوری نویسندگان فنی و سازمان‌های متن‌باز برای تقویت همکاری و بهبود مستندات در فضای متن‌باز است. Season of Docs طرح بسیار خوبی است، زیرا مستندات و مدارک یک پروژه متن‌باز راهی را برای کاربران فراهم می‌کنند تا نه‌تنها پروژه را درک کنند، بلکه در آن مشارکت کنند.

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

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

6 نکته نگارش فنی که به شما در شروع نوشتن کمک می‌کند

در اینجا چند نکته وجود دارد که باید هنگام نوشتن اولین پیش‌نویس مقاله خود به خاطر بسپارید:

• هنگام نوشتن از یک راهنمای سبک (style guide) پیروی کنید تا مطمئن شوید که از بهترین اصول نوشتن پیروی می‌کنید.
• همه‌چیز را در یک پاراگراف قرار ندهید. پاراگراف‌های خود را کوتاه کنید، به‌طوری‌که هر پاراگراف از یک ایده واحد پشتیبانی کند.
• جملات کوتاه، واضح و دقیق بنویسید.
• پس از نوشتن اولین پیش‌نویس، خودتان را جای خواننده بگذارید و مطالب را با صدای بلند بخوانید. این کار به شما کمک می‌کند تا مواردی را که می‌توان بهتر بیان کرد، تشخیص دهید.
• اولین پیش‌نویس خود را فقط وقتی تمرکز دارید، ویرایش کنید.
• با متخصصان حوزه‌ای که در‌مورد آن می‌نویسید، مشورت کرده و بازخورد بگیرید، زیرا هیچ نویسنده فنی‌ای همه جزئیات فنی مربوط به هر مبحث را نمی‌داند.

خلاصه

نگارش فنی مهارتی مورد‌نیاز در محل کار حرفه‌ای است. انتظار می‌رود تقاضا برای آن در سال‌های آینده نیز همچنان افزایش یابد.

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

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