درباره مستندات و پروژه

برای مشارکت و همکاری در پروژه نکات زیر میتونن مفید باشن:

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


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


۳. برای عبارات یا اصطلاحاتی که به کار رفتن توی پروژه و از نظرشما نمیشه اونا رو توی دو سه کلمه ترجمه کرد و نیاز به توضیحاتی بیشتر دارن یا شرایط طوری هستش که مثلا اون اصطلاح به جای یک عنوان نشسته و نمیشه یک جمله داخل عنوان نوشت، پس بهترین کار استفاده از روش زیر هستش تا نکات بیشتری که مدنظر هست، به شکل زیر به خواننده نشون داده بشن:

:help:`این متن شامل توضیحات اضافی و لازم میباشد`

و نتیجه به این شکل میشه : ؟این متن شامل توضیحات اضافی و لازم میباشد


۴. استفاده از آیدی سفارشی در هر فایل رو فراموش نکنین، هر عنوانی آیدی منحصر به فردی داره و در زبان انگلیسی sphinx به صورت پیشفرض همون نام عنوان رو به آیدی تبدیل میکنه اما اگه نیاز بشه که عنوانی رو ترجمه کنیم و متن انگلیسی نداشته باشیم، خودش یک تگ span ایجاد میکنه و به صورت پیشفرض id میده، برای همین کافیه به شکل زیر بالای هر عنوان آیدی اون رو طبق آیدی اولیه ای که داشت بهش بدین.

.. _the-custom-id:

===============
عنوان ترجمه شده
===============

و نتیجه چیزی به این صورت درمیاد:

عنوان ترجمه شده

  • همچنین توجه کنین که توی ترجمه عناوین تعداد علامت های بالا و پایین نباید کمتر از تعداد کاراکترهای عنوان باشه.

۵. در فرایند ترجمه سعی کنید هربخش کوتاهی رو که ترجمه میکنین تغییرات رو زود به زود اعمال کنید چون هر بخشی نیاز به بررسی و ریویو داره و این بخش ها هرچه جمع و جور تر باشن سرعت کار بیشتر میشه.



روز خوبی داشته باشین♥️