این مقاله نحوه افزودن و لینک دادن به مطالب موجود در واژه نامه MDN Web Docs را مورد بررسی قرار خواهد داد. همچنین راهنمایی هایی در مورد طرح بندی و محتوای مدخل واژه نامه را ارائه می کند. در این واژه نامه برای کلیه اصطلاحات، عبارات تخصصی و کلمات اختصاری تعریفی ارائه می شود که هنگام خواندن محتوای MDN در مورد وب و توسعه وب مخاطبان با آن روبرو خواهند شد.
از آنجایی که این احتمال وجود دارد که واژه نامه به علت تغییرات مداوم وب، هرگز کامل نشود، مشارکت افراد در اضافه کردن مدخل واژه نامه یا رفع مشکلاتی در این زمینه، می تواند به توسعه دهندگان در به روز کردن فرهنگ لغت و پر کردن خلا های موجود کمک کند. مشارکت در ایجاد واژه نامه روشی آسان برای کمک به فهم بیشتر وب برای همگان می باشد. برای این کار شما به مهارت های فنی سطح بالایی نیاز ندارید چرا که مقالات واژه نامه ساده و مختصر در نظر گرفته شده اند.
مطالعه مقاله چگونه می توان یک واژه نامه آنلاین ایجاد کرد؟ را به شما پیشنهاد می کنیم.
نحوه نوشتن مدخل واژه نامه
پاراگراف اول هر صفحه واژه نامه، توصیف ساده و کوتاه هر اصطلاح است. ترجیحاً این مورد بیشتر از دو جمله نباشد بهتر است. اطمینان حاصل کنید که زمانی که افراد شرحی را که برای هر مدخل واژه نامه نوشتید را می توانند فوراً درک کنند.
توجه: لطفاً از سایر تعاریف یا مطالب موجود در اینترنت کپی و پیست نکنید. ( به خصوص ویکی پدیا، زیرا طیف وسیعی از نسخه ها دارای مجوز کم و نا سازگار با MDN می باشند.) مدخل واژه نامه شما باید محتوایی اصیل داشته باشد.
نوشتن یک مدخل واژه نامه خوب
در صورت لزوم چند پاراگراف اضافی اضافه کنید. نوشتن یک مقاله پیشنهاد خوبی است، اما بهتر است که آن را در واژه نامه ایجاد نکنید. اگر مطمئن نیستید که مقاله خود را در کجا قرار دهید، در صورت تمایل در مورد آن صحبت کنید.
چند دستورالعمل ساده وجود دارد که باید برای نوشتن یک مدخل واژه نامه بهتر در نظر گرفته شود:
• هنگامی که از یک سری اصطلاحات و اختصارات در توصیف اصطلاحات واژه نامه استفاده می کنید، باید لینک های مناسبی ایجاد نمایید. این کار تنها شامل ایجاد لینک به سایر صفحات در واژه نامه است.
• اگر می توانید بدون دنبال کردن یک مقاله دشوار، از اصطلاحات مربوطه مناسب (با لینک ها) در واژه نامه استفاده کنید. داشتن یک شبکه خوب از لینک های مفید و مربوط، استفاده از یک صفحه یا مجموعه ای از صفحات را بسیار آسان می کند.
• اگر می خواهید یک صفحه را پیدا کنید، به عبارات جستجوی خود فکر کنید. سعی کنید از تمام کلماتی که برای جستجوی اصطلاح استفاده می کنید، استفاده نمایید ، در غیر این صورت واژه نامه مزخرف، طولانی یا دشوار در خواندن می شود.
گسترش لینک ها
مدخل واژه نامه باید همیشه با یک عبارت بیشتر بیاموزید، همراه باشد. این بخش باید حاوی لینک هایی باشد که به خواننده کمک می کند تا به جلو حرکت کند: جزئیات بیشتری کشف کند و فناوری مربوطه را بیاموزد.
سازماندهی لینک ها به سه دسته، تمرین خوبی به حساب می آید:
دانش عمومی
این لینک ها اطلاعات سطح بالاتری درباره اصطلاح یا موضوع را ارائه می دهند. به عنوان مثال: پیوند به صفحه مربوط به ویکی پدیا.
مرجع فنی
این لینک ها اطلاعات فنی عمیقی را در MDN Web Docs یا سایت های دیگر ارائه می دهند.
یادگیری در مورد آن
اینها لینک هایی به آموزشها، تمرینات، مثالها یا هر محتوای آموزشی دیگری است که به یادگیری خواننده کمک می کند.
مقابله با ابهام زدایی
بعضی از اصطلاحات بسته به زمینه می توانند چندین معنی داشته باشند. برای حل ابهام، دستورالعمل های زیر را دنبال کنید:
• صفحه اصلی این اصطلاح باید یک صفحه ابهام زدایی حاوی واژه GlossaryDisambiguation داشته باشد.
• این اصطلاح دارای زیرصفحه هایی است که اصطلاح مورد نظر را برای زمینه های مختلف تعریف می کند.
بیایید این را با یک مثال توضیح دهیم. اصطلاح امضا (signature) می تواند در حداقل دو زمینه مختلف معنای مختلفی داشته باشد: امنیت (security) و عملکرد (function).
1. صفحه Glossary / Signature صفحه ابهام زدایی با ماکرو GlossaryDisambiguation است.
2. صفحه Glossary / Signature / Security صفحه ای است که یک امضا را در یک زمینه امنیتی تعریف می کند.
3. صفحه واژه نامه / امضا / عملکرد صفحه ای است که یک امضا را در زمینه عملکرد تعریف می کند.
مخاطبان گرامی در نطر داشته باشید:
