این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان منبع باز:
- سیستم عامل Qubes
- نویسنده فنی:
- c1e0
- نام پروژه:
- راهنماهای عیب یابی را ادغام کنید
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
خلاصه
راهنمای عیب‌یابی برای کمک به کاربران نهایی در حل مشکلاتی که هنگام استفاده از یک محصول یا خدمات با آن مواجه می‌شوند، طراحی شده است. یک راهنمای عیب یابی خوب مهم است زیرا در هنگام بروز مشکل به کاربران کمک می کند. این باعث می‌شود کاربران در صورت مواجهه با مشکل محصول را رها نکنند. Qubes هزاران کاربر روزانه در سراسر جهان دارد که بسیاری از آنها در مقطعی از زمان با مشکل مواجه می شوند و از راهنمای عیب یابی بهره مند خواهند شد.
وضعیت فعلی راهنمای عیب‌یابی
در این لحظه، راهنمای عیب‌یابی QubesOS در بسیاری از صفحات پراکنده شده و گاهی اوقات ناقص است، که منجر به ارسال مکرر دستورالعمل‌های مشابه در هنگام کمک به کاربران برای تشخیص مشکلات می‌شود. راهنماهای موجود فاقد طرح‌بندی علامت-عمل هستند، که تطبیق یک مشکل با راه‌حل آن را برای کاربر دشوار می‌سازد. علاوه بر این، برخی از مسائل وجود دارد که به طور مکرر در رسانه های اجتماعی (Reddit)، صفحه مسائل Qubes Github و در فروم #qubes-users ذکر شده است، اما در راهنمای عیب یابی فعلی مستند نشده است.
چرا راهنمای عیب‌یابی پیشنهادی من نسبت به راهنمای فعلی بهبود یافته است؟
راهنمای عیب‌یابی پیشنهادی من برای اطمینان از دقت و ناوبری آسان، کامل و ساختار یافته خواهد بود. راهنما دستورالعمل های مختصری را نشان می دهد که نحوه حل یک مشکل را به صورت گام به گام توضیح می دهد. این یک طرح بندی نشانه-عمل نشان می دهد، که در آن یک مشکل بیان می شود، و به دنبال آن یک راه حل پیشنهادی برای حل آن مشکل ارائه می شود. عیب‌یابی‌ها برای موتورهای جستجو بهینه‌سازی می‌شوند و برای در نظر گرفتن مشکلاتی که کاربران در رسانه‌های اجتماعی و موتورهای جستجو جستجو می‌کنند، فرم‌بندی می‌شوند. همه اینها برای اطمینان از اینکه کاربران می توانند راهنمای عیب یابی رسمی را از طریق موتورهای جستجو پیدا کنند و به سرعت/به راحتی راه حل مشکلات خود را پیدا کنند انجام می شود.
ساختار راهنمای عیب یابی پیشنهادی و بازه زمانی
من یک ساختار پیشنهادی برای راهنمای عیب‌یابی Qubes OS ایجاد کرده‌ام که می‌توانید در اینجا پیدا کنید: https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPfpSwZEaczqL8/edit?usp=sharing. طرح بندی با یک بازه زمانی تخمینی همراه است که در طی آن هر بخش عیب یابی نوشته می شود. این طرح پس از بازخورد استاد راهنما اجرا خواهد شد. ساختار و چارچوب زمانی ممکن است بر اساس بازخورد مربی اصلاح شود.
اهداف پروژه
- راهنمای عیب‌یابی را بازسازی کنید تا طرح‌بندی علائم-عملی قابل‌فهم‌تر و یکپارچه‌تر داشته باشید.
- عیب‌یابی‌های موجود را بازنویسی کنید تا دستورالعمل‌های گام به گام آسان را دنبال کنید.
- در صورت لزوم اسکرین شات اضافه کنید
- Qubes را خودم نصب و امتحان کنم و هر مشکلی را که با آن مواجه می‌شوید ثبت کنید. من سه کامپیوتر دارم: Lenovo Thinkpad، Dell Latitude و Acer Aspire. من Qubes را روی هر یک از این رایانه‌ها امتحان می‌کنم، هر گونه خطا را ثبت می‌کنم و هر گونه عیب‌یابی را تأیید می‌کنم.
- هر گونه اطلاعات منسوخ شده در راهنمای موجود را حذف کنید.
- اطمینان حاصل کنید که عیب یابی دقیق است. در حال حاضر، راهنماهای عیب یابی موجود دارای پیام خطا هستند ""این اسناد غیر رسمی و شخص ثالث است. پروژه Qubes OS نمی تواند صحت این صفحه را تضمین کند. لطفا احتیاط کنید"". این هشدار پس از تأیید صحت دستورالعمل‌های عیب‌یابی کنار گذاشته می‌شود. صحت آنها با آزمایش شخصاً عیب‌یابی در رایانه شخصی من (در صورت امکان)، یا بررسی آنلاین اینکه آیا کاربرانی راه حل را تأیید کرده اند، تضمین می شود.
- هرگونه عیب یابی خارجی (از انجمن و GitHub) را به صفحه وب عیب یابی رسمی منتقل کنید.
- تحقیق کنید و مشکلات بیشتری را که کاربران از Reddit (r/QubesOS)، Stack Exchange، #qubes-users Group Google و مشکلات GitHub با آن مواجه هستند، بیابید. من همچنین از ابزارهای تحقیق کلمات کلیدی مانند Keywordtool.io و UberSuggest.com استفاده خواهم کرد تا بفهمم چه سوالاتی اغلب در موتورهای جستجو مانند Google جستجو می شوند.
- در صورتی که راهنمای عیب‌یابی مشکل کاربران را حل نکرد، بخش «دریافت کمک» را اضافه کنید. یک مثال را می توان در صفحه عیب یابی فدورا مشاهده کرد: https://docs.fedoraproject.org/en-US/fedora/rawhide/install-guide/install/Troubleshooting/#sect-troubleshooting-getting-help.
چرا این پروژه؟
من به فناوری، به ویژه امنیت سایبری و حریم خصوصی علاقه دارم. من معتقدم نوشتن یکی از قوی ترین لباس های من است. من به طور خاص به سیستم عامل Qubes علاقه مند هستم زیرا دو علاقه اصلی من را تلاقی می کند: امنیت و حریم خصوصی. من کاربر مشتاق سایر محصولات مبتنی بر امنیت و حریم خصوصی مانند DuckDuckGo و Tor هستم. من اخیراً سیستم عامل Qubes را کشف کردم و تا کنون آن را دوست دارم.
چرا من معتقدم که من شخص مناسبی برای این پروژه هستم
- من به امنیت، حریم خصوصی و نوشتن اسناد خوب/مفید علاقه دارم.
- از آنجایی که هنگام نصب و استفاده از Qubes OS مشکلاتی را تجربه کرده‌ام، می‌توانم این مشکلات را در دستورالعمل‌های عیب‌یابی بهتر نشان دهم.
- در ماه گذشته، جنبه های فنی سیستم عامل Qubes را مطالعه کرده ام. من همچنین اسناد Qubes OS را به طور گسترده مطالعه کرده ام. برای دریافت احساسی از فرآیند ویرایش اسناد، یک درخواست کشش ایجاد کردم (https://github.com/QubesOS/qubes-doc/pull/1005/files)
- من اخیرا یک دوره کارآموزی را در پروژه Tor به پایان رساندم. نقش های من پشتیبانی فنی و نویسندگی بود. در حین کار در مرکز راهنمایی، صدها سوال از کاربرانی دریافت کردم که هنگام نصب یا استفاده از مرورگر Tor با مشکل مواجه شدند. با کمک به این کاربران در عیب یابی مشکلات خود، یاد گرفتم که چگونه دستورالعمل های عیب یابی مختصر و قابل درک بنویسم.
- در حین کار در پروژه Tor، مستندات فنی را نیز با استفاده از Markdown نوشتم. من از Git، GitHub و GitLab برای کنترل نسخه استفاده کردم.