Table of Contents
مخاطبان خود را قبل از شروع بشناسید
قبل از اینکه شما هر گونه توضیحی را ارائه دهید، ابتدا باید درک کنید که چه کسی را توضیح می دهید. شرح مشابه REST API زمانی که در یک سهامدار غیر فنی در مقابل یک توسعه دهنده جوان در مقابل یک معمار فصلی قرار دارند، کاملا متفاوت خواهد بود: دانش پایه آنها چیست؟ آنها سعی دارند با این اطلاعات به دست آورند؟ چه تصورات غلط رایج ممکن است آنها را نگه دارند؟
اگر مخاطبان شما دارای پیشینه فنی کمی هستند، از پذیرفتن آشنایی با اصطلاحات اساسی مانند “Server” یا “cache” خودداری کنید، تعاریف سریع حتی برای مفاهیم به ظاهر ساده ارائه دهید، در مقابل، اگر با تمرین کنندگان با تجربه صحبت می کنید، حذف جزئیات بنیادی توضیح را کارآمد نگه می دارد.یک تکنیک مفید این است که یک “نقشه دانش” ذهنی از مخاطبان خود ایجاد کنید، سپس زبان خود را با آن تطبیق دهید.
عدم سازگاری با مخاطبان شما یکی از رایج ترین مشکلات در ارتباطات فنی است.با تشخیص نقطه شروع شنوندگان یا خوانندگان، می توانید عمق، سرعت و واژگان توضیح خود را تنظیم کنید.این سرمایه گذاری اولیه در سوالات پیگیری کمتر و حفظ بهتر است.
استفاده از زبان ساده و آنالوگ
جارگون و اختصار می توانند به سرعت مخاطبان را بیگانه کنند، هر زمان که ممکن است، جایگزین شرایط تخصصی با کلمات روزمره شوید، به جای گفتن “معماری مبتنی بر رویداد همزمان”، ممکن است بگویید “سیستمی که وظایف به طور مستقل اتفاق می افتد و با ارسال سیگنال ها ارتباط برقرار می کند.”
آنالوگ یکی از قوی ترین ابزار برای پر کردن شکاف بین ناآشنا و آشنا است.مقایسه جریان داده ها به آب جریان از طریق لوله: لوله کانال است، آب داده ها است و یک دریچه یک ترج یا محدود کننده نرخ است. چنین آنالوگها تصاویر ذهنی روشن ایجاد می کنند که چوب، با این حال مراقب باشید که یک مقایسه بسیار دور - هر استعاره ای که همیشه به آن اشاره می کند.
یکی دیگر از روش های موثر استفاده از (FLT:0) زنجیره های شایعه (FLT:1) است: با مقایسه ساده شروع کنید، سپس آن را به عنوان توضیح رشد کنید، توضیح می دهد که محاسبات ابری ممکن است با "ابر مانند یک شبکه برق است"، سپس به سرورهای مجازی به عنوان "قطعات در یک آسمان خراش" وارد کنید و در نهایت به عنوان سیستم هدایت ترافیک آسانسور بحث کنید.
شکستن اطلاعات به قطعات کوچکتر
ایده های پیچیده به ندرت در یک غده درک می شوند. مفهوم را به قطعات قابل هضم، هر ساختمان به طور منطقی در مورد یک رویکرد ماژولار نشان می دهد که مغز ما به طور طبیعی پردازش اطلاعات جدید: حافظه کوتاه مدت تنها می تواند حدود چهار تا هفت مورد را در یک بار نگه دارد.
از مراحل شماره یا نقاط گلوله برای سازماندهی توالی استفاده کنید.برای مثال، هنگام توضیح اینکه چگونه یک شاخص پایگاه داده کار می کند، ممکن است آن را به زیر تقسیم کنید:
- چه داده هایی بدون یک شاخص به نظر می رسد (یک اسکن کامل جدول).
- چگونه یک شاخص یک ساختار کوچکتر (مانند شاخص کتاب) ایجاد می کند.
- چگونه پایگاه داده از شاخص برای پیدا کردن ردیف های سریع تر استفاده می کند.
- معامله: خواندن سریع تر، آهسته تر نوشتن، ذخیره سازی اضافی.
هر بخش باید خودآزمایی باشد.هر بخش را با یک جمله کوچک یا انتقالی که منجر به قطعه بعدی می شود، پایان دهد.این داربست به مخاطبان شما کمک می کند تا یک تصویر کامل بدون احساس از دست رفتن یا غرق شدن ایجاد کنند.
استفاده از کمک های بصری و Diagrams
یک تصویر ارزش هزار کلمه دارد – به ویژه هنگامی که این کلمات فرآیندهای فنی انتزاعی را توصیف می کنند. نمایندگی های بصری می توانند روابط پیچیده را به طرح های روشن و شهودی تبدیل کنند. Diagrams، Flowcharts، نقاشی های معماری سیستم و حتی طرح های ساده در تخته سفید به زبان آموزان کمک می کند تا ساختار یک ایده را ببینند.
هنگام طراحی تصاویر، اصول اساسی وضوح را دنبال کنید:
- اجزای برچسب به وضوح
- از فلش ها برای نشان دادن جهت داده ها یا جریان کنترل استفاده کنید.
- هر نمودار را به یک مفهوم اصلی محدود کنید.
- از کد نویسی رنگی سازگار برای عناصر مرتبط استفاده کنید.
برای مستندات دیجیتال، استفاده از ابزارهایی مانند را در نظر بگیرید.io یا Lucidchart برای تولید نمودارهای حرفه ای، که کاربران می توانند برای نشان دادن جزئیات بیشتر کلیک کنند، به ویژه در آموزش های آنلاین موثر هستند.حتی ساده قبل و پس از نمودار - نشان دادن یک راه حل واضح و واضح است.
ارائه مثال های واقعی-World
مفاهیم انتزاعی زمانی مشخص می شوند که به جای توضیح "caching" در چکیده، توضیح دهید که چگونه یک کمد آشپزخانه کار می کند: شما اغلب مواد تشکیل دهنده در دسترس بازو را نگه می دارید، اما موارد کمتر رایج در ذخیره سازی زیرزمین باقی می مانند، یک مرورگر وب تصاویر و اسکریپت ها را ذخیره می کند تا بار بازدید ها را سریعتر تکرار کند.
هنگام بحث در مورد الگوریتم ها، از سناریوهای روزمره استفاده کنید.توضیح “ش” با پرسیدن مخاطبان خود برای تصور سازماندهی یک عرشه از کارت ها، “بازگشت” را می توان از طریق عروسک کلاسیک لانه سازی روسی (ماتیتوکا) یا از طریق مفهوم حل یک مشکل با حل یک نسخه کوچکتر از همان مشکل معرفی کرد.
یکی دیگر از تکنیک های قدرتمند این است که از طریق یک مثال (FLT:0) کار شده (FLT:1) راه بروید، برای یک روش فنی مانند نصب خط لوله DevOps، نشان دادن دستورات دقیق، خروجی ها و نتایج گام به گام.
تشویق سوالات و بازخورد
توضیحات فنی هرگز نباید یک برنامه پخش یک طرفه باشد. فضای ایجاد شده برای مخاطبان خود برای پرسیدن سوال، سردرگمی صوتی یا فرضیات چالش برانگیز در تنظیمات زنده، مکث و دعوت سوالات.در اسناد کتبی، شامل بخش "سوالات رایج" یا فرم بازخورد است.
گوش دادن فعال به همان اندازه مهم است، هنگامی که کسی سوال می پرسد، آن را در کلمات خود قرار دهید تا شما را تأیید کند که واقعا چه می پرسند، اغلب یک توضیح فنی شکست می یابد زیرا توضیح دهنده پاسخ سوال متفاوتی نسبت به آنچه که یادگیرنده داشته است، استفاده از سوالات به عنوان ابزار تشخیصی: آنها نشان می دهند که کدام بخش از توضیح شما نیاز به اصلاح دارد.
برای مخاطبان بزرگتر، ابزارهایی مانند Slido یا نظرسنجی های زنده می توانند سوالات ناشناس را به صورت مستند به نمایش بگذارند، اضافه کردن یک "این مفید؟" در پایان هر بخش به شما بازخورد مستقیم در درک می دهد که ارتباطات موثر آن است، بازخوردهای بازخورد کمک می کند تا رویکرد خود را در زمان واقعی تنظیم کنید.
نکات کلیدی را خلاصه کنید و ایده اصلی را دوباره تعریف کنید
در پایان هر توضیح، دایره به اصول اولیه برمی گردد. خلاصه کوتاه به مخاطبان کمک می کند تا آنچه را که آموخته اند را تثبیت کرده و مهم ترین موارد را تقویت می کند.از یک استراحت روشن و به یاد ماندنی از ایده اصلی استفاده کنید - ترجیحا در زبان ساده که هر کسی می تواند تکرار کند.
به عنوان مثال، پس از توضیح تعادل بار، ممکن است خلاصه کنید: “یک تعادل بار مانند یک پلیس ترافیک برای درخواست های وب است، ترافیک ورودی را در سرورهای متعدد توزیع می کند تا از هر سرور منفرد از غرق شدن جلوگیری کند، که برنامه شما را سریع و قابل اعتماد نگه می دارد.”این بازپرداخت یک طرفه بسیار آسان تر از توضیح دقیق است که قبل از آن است.
همچنین یک برگه تقلب یک صفحه ای یا یک نمودار ساده را که کل مفهوم را در یک نگاه به خود جذب می کند، ارائه دهید. سومaries نباید اطلاعات جدیدی را معرفی کند؛ آنها باید آنچه را که قبلاً در قالب قابل حمل و به یاد ماندنی پوشیده شده است، تقطیر کنند.
استراتژی های اضافی برای عمق
یک داستان بگویید
انسان ها برای روایت سیم کشی هستند.پی.ت.ت.ت.ت.ت.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.ک.
استفاده از فرمت های متعدد نمایندگی
افراد مختلف به روش های مختلف یاد می گیرند. ترکیب متن، نمودار، کلمات گفتاری، تمرینات دستی و اسنیپت های کد برای رسیدن به مخاطبان گسترده تر، برای موضوعات پیچیده، یک نمایش ویدئویی کوتاه می تواند بسیار مؤثرتر از صفحات نثر باشد، حتی در یک سند واحد، از جمله یک بلوک کد در کنار یک نمودار معماری و یک مقایسه متن به طور همزمان چندین سبک یادگیری را به شما می دهد.
توضیح دهید و توضیح دهید
هیچ پیش نویس اول از یک توضیح کامل نیست، پس از ارائه توضیحات، از خودتان بپرسید: آیا مخاطبان می فهمند؟ آیا آنها سوالات غیرمنتظره ای می پرسند؟ آیا آنها بعدا از واژه صحیح استفاده می کنند؟ از این بازخورد برای اصلاح توضیح خود استفاده کنید. بسیاری از نویسندگان فنی ماهر و مربیان یک مجله “بازسازی” شخصی را نگه می دارند که در آن آنها توضیح و بهبود توضیح خود را بر اساس نتایج دنیای واقعی تجدید نظر می کنند.
سعی کنید توضیحات خود را با یک همکار که متخصص در این زمینه نیست، بررسی کنید، اگر آنها بتوانند ایده اصلی را به درستی بیان کنند، توضیح شما جامد است.
نتیجه گیری
واضح و مختصر توضیح مفاهیم فنی پیچیده یک مهارت است که می تواند آموخته و اصلاح شود.با دانستن مخاطبان خود، استفاده از زبان ساده و آنالوگ، شکستن اطلاعات به قطعات، استخدام تصاویر، ارائه مثال های دنیای واقعی، تشویق تعامل و جمع آوری نقاط کلیدی، شما می توانید به طور چشمگیری بهبود اثربخشی ارتباطات خود را.
برای مطالعه عمیق تر، منابع را از Nielsen Norman Group در نوشتن فنی یا در نظر بگیرید مشاوره کسب و کار در مورد توضیح ایده های پیچیده به یاد داشته باشید که هر توضیح یک از فرصت برای ایجاد اعتماد و درک است - دو ماده کلیدی برای همکاری فنی موفق.