پیشنهاد‌ها و راهنمایی‌هایی برای تولید محتوای متنی بهتر

ترجمه و تالیف : علیرضا معمارزاده
تاریخ انتشار : 18 اردیبهشت 99
خواندن در 3 دقیقه
دسته بندی ها : آموزشی

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

در این مقاله از سایت راکت نکاتی را ذکر می‌کنیم که به تولید محتوای متنی بهتر شما کمک می‌کند.

عناوین و زیرعنوان‌ها

  • مطمئن شوید که تمام قسمت‌ها، عنوان و زیرعنوان دارند.
  • ما از سبک AP برای بزرگ کردن عناوین استفاده می‌کنیم، در عناوین تمام لغات اصلی با حروف بزرگ نوشته می‌شوند و لغات فرعی با حروف کوچک. تبدیل‌کننده عناوین یک ابزار بسیار مفید است، برای زمانی که شک دارید.
  • در زیرعنوان، از حالت جمله استفاده کنید؛ به این معنی که مانند سایر جمله‌ها با آن برخورد کنید و تنها برای حروف اول جمله، از حروف بزرگ استفاده کنید مگراینکه کلمات بعدی در جمله اسم خاص مثل اسم شخص، شرکت، کتابخانه و یا یک زبان باشند.
  • افعال باید به‌صورت ساده به‌کار روند مانند استفاده از Creat به‌جای Creating. لطفاً از پسوند ing استفاده نکنید.

استفاده از How to

  • برای استفاده از How to باید آن را در قالب ''t'' قرار دهید.
  • اگر عنوان شما شامل عبارت How to باشد، نیازی به استفاده از علامت سؤال در انتهای جمله نیست. برای مثال: How to Include an External Library in your React Code?

قالب کد، Gists و لینک‌ها

  • اسامی متغیرات، مسیرهای فایل، URLها، اسامی دایرکتوری، اسامی کلاس‌ها و مقادیر باید به‌صورت code formatted نوشته شوند. این موارد نباید به‌صورت بولد یا مورب نوشته شوند مگر آن‌که جزو قالب کد باشند و یا بخواهید برای تأکید از این حالات استفاده کنید. برای اینکه یک عبارت را به فرمت کد تبدیل کنید می‌توانید آن‌را هایلایت کرده و دکمه ' را از کیبورد بزنید.
  • اگر کد شما بیشتر از 10 خط دارد، آن‌را در یک GitHub gist با یک فایل دارای فرمت مناسب قراردهید. یک gist عمومی بسازید و URL را در قسمت Medium، paste کنید و دکمه enter را فشار دهید و مطلب شما باید در این قسمت نشان داده شود.(نکته: Medium درحال حاضر یک ایراد دارد و آن این است که تنها 11 خط از Gist را در حالت ویرایش، نشان می‌دهد. Gist ظاهر خوبی هنگام نمایش دارد).
  • لطفاً زبان‌ها، فریم‌ورک‌ها و کتابخانه‌هایی را که چندان شناخته‌شده نیستند، لینک‌دهی کنید. نیازی به لینک‌دهی Swift، Python، React، Kubernetes نیست چون بسیار معروف هستند. موارد کمتر شناخته‌شده را لینک‌دهی کنید تا خوانندگان بتوانند به‌سرعت درمورد آن‌ها اطلاعات کسب کنند.
  • هر منبع را تنها یک بار لینک‌دهی کنید. اگر به اسم یک منبع چندین بار در متن اشاره‌شده است، تنها اولین اسم را لینک‌دهی کنید.

تصاویر اولیه

به خوانندگان خود با یک تصویر مناسب خوش‌آمد بگویید.

  • مطمئن شوید که تصویر انتخابی شما یک منبع معتبر دارد. سایت‌هایی مثل Unsplash گزینه خوبی برای یافتن تصاویر مناسب و رایگان هستند و امکان لینک‌دهی به تصاویر را هم فراهم می‌کنند.
  • لطفاً از تصاویر نامناسب و شوکه‌کننده مثل تصویر مردم درحال فریاد زدن یا انجام حرکات نامناسب و یا تصاویری که اشخاص منطقی تمایلی به تماشای آن‌ها ندارند، اجتناب کنید.
  • سعی کنید از تصاویر خیلی واضح برای تصویر کاور استفاده نکنید. اگر مطلب شما درمورد ساخت یک کیف پول بیت کوین هست، از تصاویر مربوط به کیف پول‌های مخصوص اسکناس استفاده نکنید و یا اگر مطلب شما درمورد React Hooks است، از تصاویر مربوط به قلاب ماهیگیری استفاده نکنید. اگر مطلب شما درمورد Docker است، از تصاویر مربوط به کانتینرهای حمل‌ونقل استفاده نکنید.
  • همیشه لینک عکس‌هایتان را اضافه کنید مگر اینکه آن تصویر آن‌قدر رایج باشد که اساساً دامنه آن عمومی باشد.

سیاست‌ها

برای ما این نکته اهمیت دارد که برنامه‌نویسی بهتر، عاری از سیاست است. خوانندگان برای یادگیری و بهبود مهارت‌های برنامه‌نویسی و مهندسی به اینجا می‌آیند. برای شرکت در بحث‌های سیاسی در هرجای دیگری در اینترنت به‌جز اینجا می‌توانند شرکت کنند.

لطفاً از تصاویر و مثال‌هایی که به‌طور مستقیم یا غیرمستقیم به منابع سیاسی اشاره می‌کنند اجتناب کنید به‌عنوان‌مثال برای اشاره مستقیم: تصاویر یا اسامی سیاستمداران؛ مثال برای اشاره غیرمستقیم: چیزی را دوباره عالی بسازید. مثال‌های زیادی دراین‌باره وجود دارند. هیچ‌کس از یک مطلب با تصاویری از سگ‌ها یا گربه‌های بامزه عصبانی نمی‌شود.

سایر موارد

سایر مواردی که می‌توانند مفید باشند:

  • تشکر کردن از خوانندگان برای خواندن مطالب شما در قسمت نتیجه‌گیری یک کار مطلوب است اما اجباری نیست. آن‌ها بخشی از وقت خود را صرف خواندن کار شما کرده‌اند بنابراین این کار یک راه مناسب برای خداحافظی با آن‌هاست.
  • اگر وب‌سایت، شرکت، خبرنامه و یا هر راه ارتباطی دیگری دارید آن را در قسمت بیوی صفحه مجازی خود قرار دهید نه خود مطلبتان و یا اینکه ویرایشگرانی که CTAها را ادیت می‌کنند و خودشان را تبلیغ می‌کنند، درج نکنید.
  • اگر مطلب شما چندین قسمتی است، هر قسمت را به سایر بخش‌ها لینک کنید تا خواننده بتواند به مجموعه کامل آن‌ها دسترسی داشته باشد.
  • ما از Oxford comma استفاده می‌کنیم. بین موارد فهرست‌هایی که بیشتر از دو مورد هستند، باید کاما گذاشته شود.(مثل سگ‌ها، گربه‌ها و پرنده‌ها).
  • در بخش پایانی اسامی منابعی را که از آن‌ها استفاده کردید، ذکر کنید.
  • از درج لینک کتاب‌ها، دوره‌های آموزشی و سایر موارد پرهیز کنید چون با لینک‌های غیروابسته جایگزین می‌شوند.
  • لطفاً برای حرف اول هر پاراگراف از حروف بسیار بزرگ استفاده نکنید.

از توجه شما متشکرم. امیدوارم این مطالب برای شما مفید باشند. سؤال‌هایتان را در قسمت نظرات به‌راحتی درمیان بگذارید.

منبع

گردآوری و تالیف علیرضا معمارزاده
آفلاین
user-avatar

Student of Software Engineering, python Developer, i love programming and game

دیدگاه‌ها و پرسش‌ها

برای ارسال نظر لازم است ابتدا وارد سایت شوید
هیچ دیدگاهی تا به این لحظه برای این موضوع ثبت نشده است