این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه پروژه
- سازمان منبع باز:
- وردپرس
- نویسنده فنی:
- تاسیتونیک
- نام پروژه:
- مجموعه کامل و تجدید شده راهنمای سبک مستندسازی
- طول پروژه:
- دویدن طولانی مدت (5 ماه)
شرح پروژه
خلاصه داستان:
وردپرس یک سازمان نرم‌افزاری غیرانتفاعی جهانی است که با نرم‌افزاری که بر دسترسی، عملکرد، امنیت و سهولت استفاده تأکید دارد، به جوامع جهانی خدمت می‌کند. هدف وردپرس برای دموکراتیزه کردن انتشارات و نرم افزارهای منبع باز در وب تلاش می کند. در عصر دیجیتال ما، یک وب سایت به معنای واقعی کلمه نمای آنلاین یک سازمان/فرد است. و وردپرس وظیفه عظیمی را برای خدمت رسانی مؤثر به صدها میلیون کاربر - که به 35 درصد اینترنت آن نسبت داده می شود - با نرم افزار آنها انجام می دهد. برای خدمت رسانی بیشتر به این کاربران، مستندات ضروری است و توسط اکثر توسعه دهندگان، مدیران و کاربران نهایی استفاده می شود. بنابراین، اسناد را می توان به عنوان یک عامل اصلی اکوسیستم وردپرس ایجاد کرد. اسناد فعلی وردپرس شامل مجموعه ای جهانی و یکپارچه از قوانین و دستورالعمل های سبک برای انتشار نیست. انگیزه این پیشنهاد ایجاد مجموعه ای کامل و تجدید شده از دستورالعمل های سبک مستندسازی است که به طور جهانی برای اسناد وردپرس قابل استفاده است. ایده پروژه شامل ادغام تمام جنبه‌های دستورالعمل‌های طراحی و سبک مانند معناشناسی، نحو، دستورالعمل‌های دستور زبان، نقطه‌گذاری، قوانین خاص توسعه، ویژگی‌های طراحی و ویژگی‌های قالب‌بندی است. همچنین شامل قراردادهای زبانی مانند صدا، لحن، زمان، همه بخش‌های گفتار و همچنین قراردادهای نام‌گذاری است. ابزارها، زبان‌ها و پلتفرم‌های مورد استفاده وردپرس CMS، GitHub، Markdown و همچنین ممکن است شامل PHP/MySQL، HTML/CSS و جاوا اسکریپت باشد.
طرح پروژه:
وضعیت فعلی راهنماهای سبک مستندسازی وردپرس: تیم اسناد وردپرس یک روش اعلام نشده اما متفق القول از دستورالعمل های انتشار را پیاده سازی کرده است. اما هر چند وقت یکبار برخی از عناصر پیش فرض می شود و این روند به حدس و گمان تبدیل می شود. هیچ استاندارد و معیار ثابتی برای نوشتن و انتشار مقاله برای وردپرس وجود ندارد. تیم مستندسازی دستورالعمل‌های سبک خاص پروژه را نوشته است، اما هیچ‌کدام قابل اجرا نیستند. بیشتر دستورالعمل‌های سبک موجود در یک کتاب راهنما ادغام نشده‌اند، یا منسوخ شده‌اند و باید به‌روزرسانی شوند. از این رو، نیاز به طراحی و توسعه یک راهنمای سبک واحد برای استانداردسازی اسناد وردپرس وجود دارد.
اهداف:
بیش از 35 درصد از وب سایت های اینترنت بر روی وردپرس اجرا می شوند، که به نوبه خود نشان می دهد که میلیون ها توسعه دهنده و کاربر نهایی از عملکردهای چشمگیر وردپرس استفاده می کنند. مستندات یک عنصر ضروری برای کمک به این توسعه دهندگان و کاربران برای انجام کارآمد این قابلیت ها بدون هیچ مشکلی است، حتی در صورت ناراحتی. هدف کلی این پروژه پیشنهادی استاندارد کردن یک راهنمای طراحی و سبک، یکسان سازی راهنماهای سبک موجود و به روز رسانی و همچنین الحاق مقررات و مشخصات جدید برای اسناد وردپرس است. این امر باعث سهولت استفاده، سادگی و یکنواختی در اسناد وردپرس می شود.
پیاده سازی:
همانطور که توسط مربی (Jon Ang) برای این پروژه پیشنهاد شده است، پروژه را می توان در 4 مرحله مشاهده کرد: مرحله کشف، تعریف، پیاده سازی و تعمیر و نگهداری. قبل از شروع پروژه، در طول دوره قبل از کارآموزی، من با مربی خود کار خواهم کرد و یک برنامه زمانی و جدول زمانی مناسب را در امتداد خطوط زمانی و محصولات تحویلی بعدی خود نهایی خواهم کرد. من بیشتر با سیستم وردپرس و پروتکل های کاری این پروژه آشنا خواهم شد.
با شروع دوره کارآموزی، من چکیده طرح را با مربی خود بحث و پیش نویس خواهم کرد. الزامات و ضرورت ها مشخص خواهد شد. در ابتدا، من جریان اسناد و فرآیند تعامل کاربر را شرح می دهم. متعاقبا، طرح بندی هر بخش، دسته و جزء مشخص خواهد شد. سپس این طرح‌بندی‌ها توسط مربی من بررسی می‌شود. در صورت نیاز، طرح‌بندی‌ها دوباره طراحی می‌شوند و برخی از اجزاء اضافه/حذف می‌شوند. سپس تحقیقات کاربر را برای تعیین قابلیت استفاده و امکان‌سنجی جریان رابط انجام خواهم داد. متعاقباً، راهنمای سبک مستندسازی (همانطور که در نمودار زیر نشان داده شده است) در هر بخش اجرا خواهد شد. راهنماهای سبک از سایر سازمان‌ها که تحت هر مجوز منبع باز یا Creative Commons هستند می‌توانند برای پیوست کردن راهنمای ما نیز رجوع کنند. اگر در این مدت، هر گونه مشکل در استفاده پیش آمد، آنها را دوباره طراحی خواهم کرد.
تست و بهینه سازی پس از تکمیل راهنمای سبک و ادغام با HelpHub انجام خواهد شد. هر گونه آسیب پذیری، عناصر اضافی یا مؤلفه ها اصلاح خواهند شد. تست UI و کد انجام خواهد شد و اشکالات و خطاهای ناخواسته در صورت نیاز برطرف خواهند شد. یک کنترل کیفیت نهایی برای راهنمای سبک کامل برای زبان، دستور زبان، املا، علائم نگارشی و غیره انجام خواهد شد.
کارهای معلق به دلیل تاخیرهای پیش بینی نشده در دوره بافر تکمیل می شود. قابلیت‌ها یا ویژگی‌های اضافی که در طول پروژه قابل اجرا هستند، می‌توانند پس از انجام آزمایش نهایی اجرا شوند. یک طرح استقرار ساخته خواهد شد و محصول نهایی ارائه خواهد شد.
ابزار و روش ها:
اسناد در یک پلتفرم مشترک مانند Google Docs گردآوری و ویرایش خواهند شد. در صورت نیاز به انتشار از طریق GitHub، زبان های نشانه گذاری مانند Markdown یا GitHub Flavored Markdown نیز می توانند پیاده سازی شوند. برای استانداردهای طراحی و سبک، می توان به دستورالعمل های سبک منبع باز نیز اشاره کرد. در نهایت، سند تکمیل شده با استفاده از وردپرس قالب بندی و منتشر می شود.
جدول اجزاء:
این لیست کاملی از اجزایی است که می توانند در Style Guide پیاده سازی شوند. دستورالعمل‌های سند - قابلیت دسترسی، ساختار سند، رمزگذاری، منابع خارجی، حقایق، قلم‌ها، مخاطب جهانی، فراگیر بودن، قانونی بودن، دسترسی چند پلت فرم، غیر مبهم، بدون ادعای بیش از حد، طرح‌بندی صفحه، صحت سیاسی، پروتکل‌ها، ساختار امنیتی، جمله مختصر نوشتن، لحن و سبک، بی طرفانه
زبان و گرامر - اختصارات و کلمات اختصاری، تصدیق و نفی، مقالات، حروف بزرگ، بند، گفتار مستقیم/غیر مستقیم، اول/دوم/سوم شخص، جنسیت، واژه نامه، اسم، پیشوند و پسوند، حروف اضافه، ضمایر، ارجاع، زبان عامیانه و اصطلاحات، املا، اصطلاحات فنی، زمان، افعال، صدا
علائم نگارشی - آپستروف و علامت نقل قول، دو نقطه و نیمه دو نقطه، کاما، بیضی، علامت تعجب، خط تیره و خط تیره، پرانتز، نقطه، علامت سوال، علامت اسلاید
قالب‌بندی - چکیده‌ها، مقدمه، مقدمه‌ها، نام‌های تجاری، نام محصولات، زیرنویس‌ها، قطعه‌های کد، بلوک‌های کد، تاریخ و زمان، مناطق زمانی، مکان‌ها، ارزها، نام فایل‌ها، پاورقی‌ها، عنوان‌ها و عنوان‌ها، برجسته‌سازی (پررنگ، کج، زیر خط، خط خطی، نقل قول)، تورفتگی، فهرست، پیوندها و نشانی‌های اینترنتی، فهرست‌ها، نقاط گلوله، شماره گذاری، رسانه (تصاویر، ویدئوها) و تصاویر، یادداشت ها، هشدارها، نکات، اعداد و شماره تلفن، چند زبانه، ترجمه، اسکریپت های زبان، فاصله، جداول، متن، علائم تجاری، حق نسخه برداری، حق امتیاز، نقل قول ها، آموزش ها و رویه ها، عناصر رابط کاربری، واحدهای اندازه گیری
رابط کاربری - فعالیت‌ها، دکمه‌ها، قطعه‌های کد، بلوک‌های کد، رابط خط فرمان، دیالوگ‌ها، منوها و پنجره‌های بازشو، پنجره‌های بازشو و هشدارها، برگه‌ها، اصطلاحات، عناصر رابط کاربری، ویندوز
کد - CSS، HTML، JS، Markdown، MySQL، PHP، Syntax، XML
فرهنگ لغت / واژه نامه استفاده از کلمه - A تا Z