این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان منبع باز:
- عوام خلاق
- نویسنده فنی:
- جکی بینیا
- نام پروژه:
- راهنمای استفاده از تم پایه وردپرس
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
در طول مرحله درخواست نویسنده فنی GSOD-2020، چندین تعامل با Hugo Solar، که مربی پروژه مستندسازی تم پایه وردپرس Creative Commons است، داشتم.
در تماس اولیه خود با او، برای درک اهداف ایجاد راهنمای استفاده از تم پایه وردپرس به دنبال کمک بودم، او بسیار مفید بود و به سرعت مرا با پروژه همراه کرد. تمام تعاملات متوالی که ما بعد از آن داشتیم در مورد اصلاح اهداف مستندات موضوع CC WordPress Base بود.
وقتی به مرحله‌ای رسیدم، احساس کردم که الزامات و اهداف پروژه را درک کرده‌ام، سپس به ایجاد پیش‌نویس پیشنهادی برای راهنمای استفاده از تم پایه CC WordPress پرداختم.
این پیشنهاد با استفاده از قالب رسمی Creative Commons برای برنامه های کارآموزی ایجاد شده است. این اطلاعات در مورد خلاصه پروژه، ساختار پروژه پیشنهادی، و طرح بندی مستندات موضوع پایه وردپرس جدید و همچنین اطلاعاتی در مورد جدول زمانی و موارد تحویلی برای مرحله ایجاد سند ارائه می دهد.
سپس Hugo Solar پیش‌نویس پیشنهادی من را بررسی کرد و به من بازخورد داد تا بهبودها را انجام دهم. در طول این فرآیند، او همیشه در دسترس بود تا به سوالات مربوط به پروژه پاسخ دهد.
من بازخورد ارائه شده را اجرا کردم و پیشنهاد نهایی من برای مستندات نشان ساخت D&I در پیوند زیر به عنوان سند Google موجود است.
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
متناوبا، خلاصه‌ای از پیشنهاد من که در زیر آمده است:
Creative Commons - راهنمای استفاده از تم پایه وردپرس یک پیشنهاد تهیه شده توسط ژاکلین بینا، 28 ژوئن 2020
خلاصه پروژه هدف نهایی این پروژه ایجاد اسنادی غنی، شهودی، جذاب و به زیبایی ارائه شده روی جامعه برای تم پایه وردپرس Creative Commons است.
طرح پروژه مشکل در حال حاضر، تم پایه وردپرس Creative Commons هیچ سندی ندارد، این به عنوان مانعی برای استفاده موثر از موضوع در جامعه عمل می کند. هدف من ایجاد یک راهنمای استفاده کامل برای موضوع و همچنین پیاده‌سازی انتزاع‌ها در پایگاه کد فعلی موضوع WP Base است تا استفاده از تم را آسان‌تر کند.
راه حل با استفاده از چارچوب های مدرن مانند گتسبی، اسناد آینده نگر ایجاد کنید. گتسبی استارت‌هایی دارد که می‌توانیم از آنها برای بوت استرپ مستندات جدید پایه وردپرس استفاده کنیم. یک مثال شروع کننده گتسبی-گیت بوک-استارتر است که با پشتیبانی از بهینه سازی موتورهای جستجو (SEO)، نشانه گذاری، و Algolia (ابزاری که برای ادغام برای جستجو در سایت های استاتیک استفاده می شود) از جعبه خارج می شود. علاوه بر آن، هر سایتی که گتسبی ایجاد کرده است، می تواند به راحتی برای ادغام بین المللی سازی و دسترسی بهینه شود. در ایجاد مستندات، قصد من این است که آن را تا حد امکان شهودی کنم: - نوشتن اسناد به روشی آسان و قابل درک و مراقبت برای جلوگیری از ابهام و استفاده از اصطلاحات فنی پیچیده بیش از حد. - با گنجاندن تصاویر گرافیکی و رسانه در اسناد برای استفاده به عنوان کمک بصری برای یادگیری. - استفاده از مثال هایی که نحوه اجرای وظایف رایج را نشان می دهد، به عنوان مثال سفارشی سازی.
انتزاعی‌هایی که امیدوارم پیاده‌سازی کنم شامل اطمینان از این است که اکثر عملکردهای اصلی تم پایه WP مانند قلاب‌ها می‌توانند توسط کاربران پنل مدیریت وردپرس استفاده شوند. علاوه بر آن، من دوست دارم یک تم فرزند شروع کننده برای تم پایه WP در یک مخزن جداگانه ایجاد کنم. داشتن یک طرح زمینه کودک آغازگر، تجربه ورود روان‌تر و سریع‌تری را برای کاربران جدید فراهم می‌کند. پس از تکمیل و تایید مستندات، به صورت آنلاین منتشر و میزبانی می شود.
ساختار پیشنهادی راهنمای استفاده از تم پایه CC WordPress - مستندات پیشنهادی به بخش‌های مختلفی تقسیم می‌شود که در زیر فهرست شده‌اند. موارد زیر لیست زیر هر بخش پیشنهادی سپس جزئیات بیشتری را در مورد محتوای واقعی که در بخش های مربوطه یافت می شود ارائه می دهد.
بخش بررسی اجمالی - تعریف، اهداف و ویژگی های تم پایه وردپرس Creative Commons (CC) را تشریح کنید. * تعریف: به طور خلاصه تم پایه CC WP را توضیح دهید. * اهداف: اهداف/ مقاصد تم پایه CC WP * ویژگی ها: ویژگی های تم پایه CC WP را مشخص کنید
بخش شروع - الزامات * شرایط لازم برای نصب قالب پایه وردپرس CC به عنوان مثال - نسخه وردپرس - نسخه PHP - Composer و غیره - راهنمای نصب * نحوه استفاده کاربران از zip برای نصب تم وردپرس CC * نحوه شروع کار توسط کاربران را توضیح دهید شبیه سازی تم پایه WP از GitHub. * نحوه نصب وابستگی های کاربران را در پروژه مشخص کنید. * توضیح دهید که کاربران چگونه می توانند وابستگی Queulat را پیکربندی کنند. * توضیح دهید که چگونه کاربران می توانند موضوع را در محیط توسعه وردپرس محلی خود فعال کنند.
راهنمای استفاده - نمای کلی * اصطلاح تم کودک را توضیح دهید * مزایای استفاده از تم کودک را بیان کنید. * به کاربران اطلاع دهید که روش توصیه شده برای ویرایش تم پایه WP از طریق تم کودک است. * این واقعیت را برجسته کنید که تم پایه WP باید نصب و فعال شود قبل از اینکه کاربران بتوانند یک تم کودک بسازند.
استفاده از یک طرح زمینه کودک - توضیح دهید که چگونه کاربران می توانند با استفاده از یک استارتر یک تم فرزند از تم پایه WP ایجاد کنند. از یک ویدیو برای توضیح اینکه چگونه کاربران می‌توانند یک طرح زمینه کودک را از ابتدا ایجاد کنند، استفاده کنید.
سفارشی سازی در زیر بخش های فهرست شده در زیر، نحوه استفاده کاربران از سفارشی ساز وردپرس و پنل مدیریت وردپرس را برای سفارشی سازی بیان می کنیم. ما همچنین استفاده از تصاویر گرافیکی را برای شهودی تر کردن توصیفات خود در نظر خواهیم گرفت. - سفارشی کردن توضیحات سایت یا خط برچسب. - منوهای پیمایش سفارشی - سفارشی کردن CSS - افزودن صفحات - افزودن پست ها - ابزارک ها - افزودن و حذف ویجت ها از پنل مدیریت وردپرس - افزودن ویجت ها با استفاده از Customizer با پیش نمایش زنده
بخش سفارشی‌سازی‌های پیشرفته - سفارشی‌سازی بخش CSS * مؤلفه‌هایی را که استایل موضوع را تشکیل می‌دهند توصیف کنید: - واژگان CC - Bulma - Sass * نحوه راه‌اندازی Sass در پروژه را توضیح دهید. توضیح باید حاوی اطلاعاتی در مورد: (i) مکان فایل‌های sass در ساختار پروژه (ii) اسکریپت‌های npm که می‌توانند برای ساخت و تماشای sass استفاده شوند * توضیح دهید که چگونه کاربران می‌توانند سپس سبک‌های sass را در موضوع کودک سفارشی کنند. از طریق نصب وابستگی‌های خاص npm * توضیح دهید که چگونه از کلاس مؤلفه (class-component.php) برای سفارشی‌سازی سبک‌های مؤلفه‌های خاص استفاده می‌شود.
- بخش قلاب
بررسی اجمالی
- اصطلاح قلاب را توضیح دهید
- توضیح دهید که چرا کاربران باید از قلاب ها استفاده کنند.
- انواع قلاب های موجود را مشخص کنید.
استفاده از Actions
- اقدامات موجود در موضوع WP Base و موقعیت آن را فهرست کنید
- توضیح دهید که چگونه می توان این اقدامات را اجرا کرد.
*استفاده از فیلترها - فیلترهای موجود در موضوع را فهرست کنید و نحوه اجرای آنها را توضیح دهید
به روز رسانی بخش تم - توضیح دهید که چگونه کاربران می توانند موضوع را به روز کنند.
بخش مجوز * در مورد مجوز پروژه و معنای آن برای افرادی که ممکن است بخواهند از تم پایه CC WP در پروژه های شخصی خود استفاده کنند، توضیح دهید.
بخش مشارکت * یک راهنمای مشارکتی با جزئیات کامل اضافه کنید * قوانین رفتار را مشخص کنید * انجمن: اطلاعاتی در مورد کانال های انجمن Creative Commons و نحوه مشارکت مشارکت کنندگان و غیره ارائه دهید.