5 نکته برای بهبود نگارش فنی به ویژه برای نویسندگان دنیای علوم رایانه

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

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

1. مخاطبان خود را مشخص کنید؛

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

بسته به متن، حتی ممکن است برای مخاطبان مختلف، بخش‌های مختلفی و با ویژگی‌های متفاوت نوشته شود. این مورد درباره تهیه یک گزارش حرفه‌ای هنگام ایجاد بخشهایی مانند «چکیده اجرایی» (برای توضیح به مدیران ارشد از آنچه در فرآیند اجرایی انجام می‌شود) در برابر «یافته‌های تفصیلی» (برای توضیح ابعاد و ریز جزئیات کارهای اتمام یافته که حتماً شامل وجوه فنی است) پدیده‌ای معمول است. اگرچه این مورد همیشه برای وبلاگ‌نویسان فنی به دلیل ماهیت وبلاگ، قابل استفاده نیست؛ اما، اهمیت درک مخاطبان و تنظیم متن متناسب با آنان را برجسته می‌کند.

2. بر محتوای خود تسلط پیدا کنید؛

هنگامی که مخاطبان خود را شناسایی کردید، تسلط بر مطالب برای شکستن مسائل به سطوح پایین و پرداختن به جزئیات بسیار مهم است؛ به نقل از آلبرت انیشتین:

«اگر نمی‌توانید آن [مطلب] را برای کودکی شش ساله توضیح دهید، خودتان نیز آن را درک نکردید!»

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

3. قالب‌بندی کلیدی و ضروری است؛

اگر املای لغات درست به نظر ب2رسند، توجه زیادی را به خود جلب نخواهند کرد؛ اما، استفاده از فضای سفید، پی نویسی، توضیحات تکمیلی و پشتیبانی متن با تصاویر، راهی عالی برای افزایش زیبایی‌شناسی و جذب خوانندگان بالقوه است. این مورد از منظر محتوا نیز صادق است. تقسیم مباحث به بند (پاراگراف)های کوتاه و قابل هضم می‌تواند به تمرکز بر روشن و قابل فهم بودن پیام متن، به ویژه در مباحث پیچیده، کمک کند.

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

4. انتخاب بهترین روش برای نمایش کد؛

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

بلوک‌های استاندارد

روش استاندارد تعبیه کد، قرار دادن کد از طریق بلوک‌های خاکستریِ تقسیم شده است. این بهترین روش برای مثالهای کوتاهی است که برای ارائه نکات متن ارزشمند هستند. این بلوک‌ها وقتی به صورت توالی‌های پیچیده و طولانی کد ارائه می‌شوند، ممکن است قالب‌بندی یا زیبایی نوشتار شما را تحت تأثیر قرار داده یا از بین ببرند:

#!/bin/python3
print("به عنوان مثال، راهنمای پایتون هنگام کدگذاری حداکثر طول خط 72 کاراکتر را توصیه میکند")

گیتهاب گیست

یک روش جایگزین برای استاندارد فعلی از طریق gist.github.com است. گیتهاب در گیست، میزبانی رایگانی با پشتیبانی از محتوای جایگذاری (Embed) از طریق کد HTML را برای برنامه نویسان فراهم می‌کند. این امکان، یک روش عالی برای حفظ فاصله، دقت و ارائه جذابیت بصری از طریق برجسته‌سازیِ نگارشی در کدهاست. شماره گذاری خطوط، یکی دیگر از ویژگی‌های خوب این زیرمجموعه گیتهاب است که به شما امکان می‌دهد به وجوه خاصی از کد مراجعه کنید:

Image for post
Image for post

استفاده از تصاویر

بسته به طول کد، محتوای جایگذاری، بهترین گزینه برای نمایش نیست. منظور این است که، آیا شما وقت خودتان را صرف خواندن چیزی با بلاک کدی که بیش از 30 خط ادامه دارد، می‌کنید؟ البته که به هیچ وجه! یکی از ترفندهایی که می‌توان برای نشان دادن مثالهای بزرگتر و طولانی‌تر به کار برد، در عین حال که قالب‌بندی حفظ می‌شود، تبدیل کد کامل یا جزئی از آن به یک تصویر است. البته، تهیه یک مخزن گیتهاب برای کپی کردن کدها، در صورتی که برای کاربران لزوم آن در نظر گرفته شده باشد، بسیار مفید است. این روش، همان مزایای بصری قطعه کد را فراهم می‌کند اما نیمی از فضای مقاله یا متن شما را اشغال می‌کند:

Image for post
Image for post

5- تمرین، تمرین، تمرین.

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

نکته پایانی

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