راهنمای استایل مستندسازی برای مشارکت کنندگان

موارد زیر الزامات پایه را هنگام قالب بندی مطلب مستندات شما تعیین می کند.

مراجع

راهنمای مشارکت کنندگان

واژه نامه اصطلاحات

صفحات مرور کلی

مطلبی که یک بخش را با مقدمه ها و پیوندهایی به زیربخش ها معرفی می کند.

پاراگراف مقدمه

پیوندها به بخش ها همراه با توضیحات مختصر

برای قالب بندی هر پیوند از تورفتگی استفاده کنید
پیوند دقیقاً همان گونه است که در منو ظاهر می شود.
پس از پیوند یک خط تیره بلند (فاصله-خط تیره بلند-فاصله) و سپس یک یا دو جمله مقدمه ای درباره زیربخش می آید که توضیح می دهد چگونه موضوع کلی را گسترش می دهد.

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

پیوند دادن به یک زیربخش

پیوندهای زیربخش

سرتیترها

حالت تیتر (Title Case)

با حروف بزرگ بنویسید

کلمه اول و آخر (همیشه)
اسم ها، افعال، صفت ها، قیدها
کلمات 4 حرف یا بیشتر (یک قانون کلی رایج)

با حروف کوچک بنویسید

حروف اضافه کوتاه: in, on, at, by, for, of, up, to
حروف تعریف: a, an, the
حروف ربط کوتاه: and, but, or, nor, so, yet

مثال

A Guide to the Rules of Title Case and How to Use Them

علامت و (&)

فقط در منوها به عنوان جایگزینی برای کلمه "and" استفاده شود، اما هرگز در عنوان مطالب.

آیتم منو

6 Pagination & Read More

عنوان مطلب

6 Pagination and Read More

شماره گذاری

وقتی محتوا از یک طرح شماره گذاری شده یا ساختار فهرست پیروی می کند، در انتهای عدد نقطه اضافه نکنید.

بله

6 Pagination and Read More

خیر

6. Pagination and Read More

برچسب ها

آموزش
مدیریت محتوا
ساخت سایت
نگهداری سایت

عکس های صفحه نمایش

برای راهنمایی دقیق تر به نکاتی برای عکس های صفحه نمایش بهتر مراجعه کنید.

نکات: عرض 1500 تا 2500 پیکسل؛ پس زمینه روشن (نه تیره) مرورگر؛ برش مناسب برای جهت دهی کاربر و نمایش جزئیات مرتبط؛ بزرگنمایی مرورگر برای بهبود خوانایی متن؛ فرمت فایل PNG.

زیرنویس ها

وقتی با زیرنویس پیکربندی شود (کلیک راست کرده و گزینه زیرنویس را علامت بزنید)، تصویر در یک بلوک <figure> با زیرنویس مناسب قرار می گیرد؛ در غیر این صورت تصویر به صورت استاندارد و درون خطی نمایش داده می شود.

قرارگیری

اندازه

عرض های استاندارد: 960 پیکسل برای عرض کامل، و 320 یا 640 پیکسل برای عرض های جزئی.

عرض های بزرگ (بیشتر از 1000 پیکسل) به طور خودکار در مرورگر به اندازه عرض مطلب تغییر اندازه داده می شوند. تصاویر کوچک تر در سمت چپ تراز می شوند.

منبع

اگر عکس صفحه نمایش شامل تصاویری باشد، آیا باید منبع را ذکر کنیم؟ و چگونه؟