محتوا و لحن

اصل کلی

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

رسمی در برابر محاوره

دکمه‌ها

روی دکمه اسم کار می‌آید، و مفعول فقط وقتی کار بدون آن مبهم است. بیشتر پیش‌فرض‌های سیستم طراحی همین صورت را دارند («انصراف»، «کپی»، «تلاش مجدد»). استثنا ConfirmDialog است: پیش‌فرض‌های آن («آیا مطمئن هستید؟» و «تایید») عمومی‌اند و این قاعده را برآورده نمی‌کنند، پس عنوان و برچسب دکمهٔ تأیید را همیشه خودتان بدهید (title و confirmLabel).

• دکمهٔ تأیید همان کار را تکرار می‌کند: «حذف»، «انتشار»، «ارسال». «بله» و «تأیید» بدون خواندن عنوان معنایی ندارند.
• فعل امر با «-ید» فقط در متن و راهنما می‌آید، نه روی دکمه: «فیلترها را کم کنید».
• اول‌شخص فقط روی چک‌باکس رضایت: «شرایط استفاده را می‌پذیرم».
• دکمه حداکثر سه واژه است.

پیام‌ها

• پیام کوتاه (toast) حداکثر شش واژه است و عنوان حالت خالی حداکثر پنج واژه.
• پیام خطا به کد خطا ارجاع نمی‌دهد («خطای 500»)؛ اگر شناسه لازم است، در جزئیات بیاید.
• انتظار را با زمان بگویید، نه با خواهش: «بارگذاری حدود یک دقیقه طول می‌کشد.»

«لطفاً»، «!» و ایموجی

• «لطفاً» در رابط نمی‌آید. فعل «-ید» خودش مؤدبانه است: «دوباره تلاش کنید».
• «!» هیچ‌جا نمی‌آید، حتی در خوشامد.
• ایموجی در رابط و ایمیل نمی‌آید. (در پست شبکهٔ اجتماعی حداکثر یکی، و هرگز در تیتر: صدا و لحن.)

برچسب فیلد و متن جای‌نگهدار

برچسب فیلد اسم است:

✓  نام کاربری
✓  نشانی ایمیل
✓  شماره تلفن
✗  نام کاربری خود را وارد کنید

متن جای‌نگهدار (placeholder) نمونه یا راهنمای کوتاه است، نه جای برچسب:

✓  مثال: name@example.com
✓  جستجو در اینفلوئنسرها…
✗  لطفاً ایمیل خود را وارد کنید

ریزمتن‌ها

راهنمای شناور

✓  نرخ تعامل = (لایک + کامنت + ذخیره) ÷ دنبال‌کننده
✗  engagement rate

متن جستجو

✓  جستجو در اینفلوئنسرها…
✓  نام کاربری، نام یا هشتگ

اعداد و تاریخ

• در کد، عدد را با رقم لاتین بنویسید و با قالب‌دهنده‌های سیستم طراحی قالب بدهید. زیر lang="fa" فونت آن را با رقم فارسی نشان می‌دهد و خود رشته لاتین می‌ماند: کپی، جستجو، مرتب‌سازی و صفحه‌خوان سالم می‌مانند.
• شناسه‌ها لاتین می‌مانند: نام کاربری، نشانی وب، IP و کدهایی مثل T0023. راه رسمی آن در فارسی اول آمده است.
• رقمی که در متن ثابت فارسی تایپ می‌کنید باید رقم فارسی باشد (U+06F0 تا U+06F9)، نه عربی.
• جداکننده‌ها همان‌هایی‌اند که قالب‌دهنده‌ها می‌سازند: هزارگان با کامای لاتین و اعشار با نقطه، «1,234,567» و «4.2٪». جداکننده‌های «٬» و «٫» به کار نمی‌روند.
• مقدار مختصر با واژهٔ فارسی: «1.2 میلیون»، نه 1.2M.
• تاریخ شمسی است: yyyy/MM/dd («1402/12/15») یا با نام ماه («15 اسفند 1402»)، نه March 5, 2024.
• بازهٔ زمانی: «30 روز گذشته»، «از 1 فروردین تا 31 فروردین».
• درصد با ٪، و واحد به فارسی: «12 گیگابایت»، «45 ثانیه»؛ پسوند لاتین روی رقم فارسی نمی‌آید.

جزئیات و قالب‌دهنده‌ها در قالب‌بندی عدد و تاریخ آمده است.

نوشتار فارسی

نیم‌فاصله

نیم‌فاصله (U+200C) میان جزءهای یک واژه می‌آید، جایی که حرف پیش از آن به حرف بعد می‌چسبد:

✓  دنبال‌کننده · می‌شود · نمی‌توان · بسته‌بندی · گزارش‌ها
✗  دنبال کننده · میشود · نمی توان

پس از حرف ناچسبان (ا، د، ذ، ر، ز، ژ، و) لازم نیست: «پرتوها»، «کاربرها».

املا

• کسرهٔ اضافه پس از «ه» ناملفوظ با «ـهٔ»: «گزارش هفتهٔ گذشته»، «نسخهٔ جدید».
• «تأیید»، نه «تایید».
• «اینجا» و «آنجا» پیوسته.
• «ی» و «ک» فارسی (U+06CC و U+06A9)، نه «ي» و «ك» عربی؛ مگر در متن locale عربی.

رقم را لاتین بنویسید؛ فونت فارسی‌اش می‌کند

در متن رابط و مستندات رقم را لاتین (0–9) بنویسید، نه فارسی (U+06F0–U+06F9) و نه عربی (U+0660–U+0669). زیر lang="fa" فونت آن را فارسی نشان می‌دهد؛ خواننده فرقی نمی‌بیند، ولی کپی و جستجو و صفحه‌خوان رقم لاتین می‌گیرند و دیگر دو خانوادهٔ رقم در یک متن قاطی نمی‌شوند.

حروف بزرگ در اصطلاح لاتین

✓  React · TypeScript · CSS Variables · API
✗  react · Typescript · css variables

علائم سجاوندی

✓  ویرگول «،»، نقطه‌ویرگول «؛»، پرسش «؟» و گیومهٔ «»
✗  ویرگول لاتین «,» و نقل‌قول با "دابل کوت"

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

واژگان

فهرست رسمی واژگان پرتو فایل terminology.json در بستهٔ @partodata/ui است. 3 واژه حکم دارند و check-terminology در CI مترادف ممنوعشان را رد می‌کند:

صورت‌هایی که هنوز حکم ندارند (پیشنهادی، مثل «رمز عبور» و «جستجو») و واژه‌های خود برند در واژگان در راهنمای برند آمده‌اند. تا حکم، همان صورت پیشنهادی را یکدست به کار ببرید.

یادداشت انتشار

یادداشت‌های «آخرین تغییرات» هم متن رابط‌اند. ساختار و کامپوننت‌ها در آخرین تغییرات آمده است؛ قاعده‌های نوشتن:

• هر تغییر می‌گوید کاربر حالا چه کاری می‌تواند بکند، نه اینکه تیم چه ساخت: «گزارش‌ها را می‌توانید زمان‌بندی کنید».
• توضیح یک تغییر یک یا دو جمله است، حداکثر 200 نویسه.
• برچسب تغییری که رفتار موجود را عوض می‌کند «تغییر مهم» است، نه اصطلاح مهندسی «تغییر ناسازگار».
• نسخه شناسه است و لاتین می‌ماند: «نسخهٔ 4.2.0».
• عنوان ریلیز را به‌عنوان اولین تغییر تکرار نکنید.

خلاصه

قاعده‌های متن رابط در یک نگاه؛ همین فهرست در صدا و لحن هم آمده است:

• دکمه: اسم کار، و مفعول وقتی کار مبهم است: «ذخیره»، «حذف کمپین»، «ساخت گزارش». دکمهٔ تأیید همان کار را تکرار می‌کند («حذف»)، نه «بله» یا «تأیید»؛ و «انصراف» لغو می‌کند.
• پیام موفقیت: «[شیء] [فعل ماضی]»: «تغییرات ذخیره شد». بدون «با موفقیت».
• پیام خطا: برای کاری که انجام نشد: «[آنچه انجام نشد]. دوباره تلاش کنید.»، مثل «گزارش ساخته نشد. دوباره تلاش کنید.» خطای یک فیلد یا ورودی فیلد و راه درست کردنش را می‌گوید: «نشانی ایمیل کامل نیست.»
• حالت خالی: چه چیزی خالی است، قدم بعد چیست، و یک اقدام.
• گفت‌وگوی تأیید: عنوان شیء را نام می‌برد («کمپین «تخفیف فصلی» حذف شود؟»)، متن پیامد را می‌گوید («این کار برگشت‌پذیر نیست.») و دکمه‌ها «حذف» و «انصراف»اند. در ConfirmDialog عنوان و برچسب دکمهٔ تأیید را همیشه خودتان بدهید (title و confirmLabel)؛ پیش‌فرض‌های آن عمومی‌اند.
• «لطفاً»: در رابط نمی‌آید؛ فعل «-ید» خودش مؤدبانه است.
• «!»: هیچ‌جا نمی‌آید، حتی در خوشامد.
• ایموجی: در رابط محصول و ایمیل نمی‌آید؛ در پست شبکهٔ اجتماعی حداکثر یکی، و هرگز در تیتر.
• طول: دکمه حداکثر سه واژه، پیام کوتاه (toast) حداکثر شش واژه، و عنوان حالت خالی حداکثر پنج واژه.

• لحن رسمی (شما، با «-ید»)، آرام، دقیق و روشن.
• عدد در کد لاتین؛ جداکنندهٔ لاتین؛ تاریخ شمسی.
• واژهٔ حکم‌شده از terminology.json.

صفحات مرتبط

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