این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان منبع باز:
- VLC
- نویسنده فنی:
- Avii
- نام پروژه:
- ایجاد مستندات کاربری VLC برای یک پورت تلفن همراه (اندروید)
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
خلاصه
اسناد کاربر به عنوان یک سیستم پشتیبانی ثابت برای کمک به کاربران نهایی استفاده می شود. اطلاعات فنی و غیر فنی را در مورد یک محصول یا خدمات ارائه می دهد. این به کاربران کمک می کند تا نحوه استفاده از نرم افزار یا خدمات را بیاموزند. اگر تنها چیزی که نیاز دارد راهنمایی، راهنمایی یا ترفند کوچکی باشد، هر فردی نمی‌خواهد با پشتیبانی تماس بگیرد یا منتظر پاسخ ایمیل باشد. اسناد کاربر فقط این کار را انجام می دهد. همچنین هزینه های پشتیبانی را کاهش می دهد و هویتی از سلامت محصول و تیم توسعه دهنده است.
VLC برای اندروید بیش از 100 میلیون بار تنها از فروشگاه Google Play دانلود شده است. VLC ویژگی های زیادی را برای پورت های تلفن همراه خود از پخش صوتی و تصویری گرفته تا جریان شبکه ارائه می دهد. اغلب مردم می خواهند از این ویژگی های عالی استفاده کنند اما نمی توانند این کار را انجام دهند. جستجوی یک وبلاگ یا یک ویدیوی تصادفی برای این کار نیاز به زمان و حوصله زیادی دارد و هنوز صحت اطلاعات به دست آمده وجود ندارد. در حال حاضر، VLC مستندات کاربر اندروید VLC را در صفحه ویکی میزبانی می‌کند و توضیحی کمتر یا بدون شرح این ویژگی‌ها ارائه می‌کند. علاوه بر آن، صفحات ویکی آخرین بار در مارس 2019 به‌روزرسانی شدند. پروژه فعلی اسناد کاربر جدید را با طراحی مدرن و سهولت استفاده بیشتر برای پورت اندروید ارائه می‌کند.
وضعیت فعلی
صفحات ویکی کاملا قدیمی هستند و حاوی اطلاعات بسیار کمتری در مورد آخرین نسخه VLC هستند. همچنین، هدایت آنها آسان نیست. هیچ گزینه قابل مشاهده ای برای خواندن اسناد به زبان دیگری غیر از انگلیسی وجود ندارد. اصلاً شامل توضیحات ویژگی نیست.
تحلیل و بررسی
-> در حال حاضر مستندات فعلی منسوخ شده است و باید به روشی جدید و با استفاده از پلتفرم و ابزار متفاوت نوشته شود.
-> اکثر کاربران اندروید دانش فنی کمی دارند یا اصلاً دانش فنی ندارند. اما افرادی هستند که به اطلاعات فنی بیشتری در مورد یک ویژگی نیاز دارند. نوشتن و نگهداری دو سند مجزا برای هر یک از اهداف فوق ایده خوبی نیست. یا حتی در همان مستندات، تقسیم یک ویژگی بر اساس فنی و غیر فنی، سردرگمی اضافی ایجاد می کند. از آنجایی که باز هم بیشتر کاربران به رابط کاربری که می بینند یا ویژگی هایی که استفاده می کنند عادت دارند، تشخیص فنی یا غیر فنی بودن چیزی برای همه آسان نیست. بنابراین ما می خواهیم این را برای آنها ساده کنیم.
-> اکثر کاربران سعی می کنند اطلاعات را از طریق گوشی هوشمند خود دریافت کنند و از طریق دسکتاپ یا سایر دستگاه ها استراحت کنند. بنابراین مستندات باید به راحتی با هر اندازه صفحه نمایش سازگار شوند. و هیچ سردرگمی در مورد ناوبری ایجاد نمی کند.
-> همه ویژگی های نسخه دسکتاپ در پورت اندروید موجود نیست و اگر موجود باشد در هر دو پورت یکسان کار نمی کند. این به این دلیل است که برنامه دسکتاپ برای مدت طولانی تری در حال توسعه بوده و به نوعی حالت اشباع دست یافته است، در مقابل پورت موبایل نسبتاً جدید است و هنوز در حال توسعه است. به غیر از آن، اگرچه امروزه دستگاه‌های تلفن همراه بسیار قدرتمند شده‌اند، محدودیت‌های آشکاری در مورد نوع ویژگی وجود دارد که می‌توانیم عمدتاً به دلیل تقاضای کاربر نهایی استفاده کنیم. داشتن یک ویژگی که هیچ کس از آن استفاده نمی کند، هدر دادن منابع توسعه است. بنابراین گفتگو با هر دو سند بر اساس ویژگی ها توصیه نمی شود.
بر اساس تجزیه و تحلیل فوق، موارد زیر را پیشنهاد می کنم. 1. در حال حاضر اسناد کاربر دسکتاپ از مولد اسناد Sphinx و Read theme Docs استفاده می کند. استفاده از همان پورت اندروید به روش های زیر به ما کمک می کند: -> ادغام آسان هر دو سند. -> برای تمام اندازه های صفحه نمایش بهینه شده است. -> تجربه یکپارچه هنگام پیمایش به اسناد کاربر Android از طریق اسناد دسکتاپ
- تفکیک فصول، بخش ها و زیربخش ها بر اساس موقعیت نسبی آنها در کاربرد. به عنوان مثال - حالت پس‌زمینه/PiP در داخل بیشتر است -> تنظیمات-> ویدئو، بنابراین ساختار فصل خواهد بود
- بیشتر
- |__تنظیمات
- | |__کتابخانه رسانه ای
- | |__ویدئو -->حالت پس زمینه/PiP
- : -> این رویکرد سهولت دسترسی را بهبود می بخشد زیرا کاربران می توانند با مقایسه آن با مکان نسبی در برنامه به راحتی به قسمتی که در آن به کمک نیاز دارند پیمایش کنند. برای هر یک از ویژگی ها می توانیم قسمت های فنی و غیر فنی را بیشتر از هم جدا کنیم. ابتدا یک توصیف آسان غیر فنی می نویسیم و سپس قسمت های فنی همان ویژگی را، در صورت وجود، دقیقاً در زیر آن برجسته یا برچسب گذاری می کنیم. این ممکن است منجر به تکرار شود، اما تجربه آسان اکثریت غیر فنی را تضمین می کند. این همچنین در آینده با افزایش قابلیت نگهداری کمک خواهد کرد. از آنجایی که برنامه به حالت اشباع می‌رسد، رابط کاربری نسبی احتمالاً تغییر زیادی نخواهد کرد، بنابراین در آینده اگر یک ویژگی جدید اضافه یا حذف شود، می‌توانیم به سادگی بخش را تغییر دهیم. در صورتی که کل رابط کاربری تغییر کند، می‌توانیم بخش‌ها/فصل‌ها را دوباره مرتب کنیم یا کل سند را بازسازی کنیم، در هر صورت باید کل مستندات را اصلاح کنیم، زیرا باید اسکرین‌شات را برای مطابقت با رابط کاربری فعلی جایگزین کنیم. یک نسخه آزمایشی در اینجا میزبانی می شود: https://avinal.gitlab.io/vlc-android-docs/
هر بخش از مستندات باید شامل یک اسکرین شات برچسب دار، شرح ویژگی، بخش فنی تر در صورت وجود و نکات و ترفندهایی برای ویژگی باشد.
-> توسعه مستقل این مستندات کاربر از روی دسکتاپ به ما کمک می کند تا هر دو سند را تنها در چند مرحله ادغام کنیم بدون اینکه بر اسناد فعلی تأثیر بگذاریم یا در طول توسعه تحت تأثیر آن قرار بگیریم. من پیشنهاد می‌کنم پس از توسعه، کل این مستندات را در بخش Android اسناد دسکتاپ قرار دهید و سپس یک پیوند دائمی برای VLC برای اسناد اندروید ایجاد کنید.
-> بهبودهای بیشتر ممکن است شامل طراحی مجدد صفحه شروع اسناد کاربر دسکتاپ باشد تا به کاربران اجازه دهد مستقیماً سیستم عامل مورد علاقه خود را انتخاب کنند و سپس به اسناد سیستم عامل انتخابی هدایت شوند. از آنجایی که اسناد کاربر Windows، MacOS و Linux VLC در حال حاضر به خوبی طراحی و گفتگو شده است، ممکن است گزینه هایی را برای انتخاب از بین Windows/MacOS/Linux یا Android یا iOS قرار دهیم. این منجر به ایجاد اسناد کاربر به خوبی جدا شده اما یکپارچه با تنها یک پیوند برای استفاده برای همه پورت ها می شود.
چرا اسناد کاربر پیشنهادی من بهتر است؟ این مستندات کاربر پیشنهادی بر اساس الگوهای رایجی که کاربر نهایی برای دریافت کمک دنبال می کند، ساختار یافته است. این مستندات تمام ویژگی‌های مورد نیاز را ترکیب می‌کند، مانند سادگی، وضوح، ظاهر و احساس، دانش فنی برای به حداکثر رساندن سهولت استفاده و تجربه کاربر نهایی. این نیز به راحتی قابل نگهداری است زیرا دیگر نیازی به نگهداری اسناد شخصی برای هر پورت نیست.
چرا من شخص مناسبی برای این پروژه هستم؟ -> من الان 2 سال است که کد می نویسم و اغلب باید اسناد API را برای کتابخانه های خاص یا برخی نرم افزارها مرور کنم یا حتی کد خودم را مستند کنم. بنابراین من دقیقا می‌دانم که مردم می‌خواهند در مستندات چه چیزی را ببینند، با چه مشکلی روبرو هستند و برای دریافت کمک چگونه برخورد می‌کنند. من می توانم از همین تجربه برای نوشتن یک مستند سازگار و به راحتی قابل خواندن استفاده کنم.
-> من به طور فعال در حال نوشتن مطالب فنی در Quora، Stack Overflow و پلتفرم های مختلف دیگر بوده ام. من می دانم چگونه مسائل را به گونه ای توضیح دهم که جذاب باشد و مردم به راحتی بفهمند.
-> VLC برای اندروید یک ابزار قدرتمند و بسیار معروف است، اما بسیاری از ویژگی های آن یا ناشناخته هستند یا هیچ کمکی در دسترس نیست. من سال هاست که از VLC بر روی پلتفرم های دسکتاپ و موبایل استفاده می کنم و می دانم که ممکن است یک کاربر با چه مشکلاتی مواجه شود. با ترکیب تمام دانش و تجربه‌ام می‌توانم به یک مستند عالی اطمینان دهم.