این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه پروژه
- سازمان منبع باز:
- زیرساخت کامپایلر LLVM
- نویسنده فنی:
- DR87
- نام پروژه:
- فهرست اسناد LLVM و راهنمای سبک مستندسازی را بازسازی کنید
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
این پروژه شامل وظایف زیر است:
الف) صفحه فهرست اسناد را بازسازی کنید تا تجربه کاربر پسندتری را ارائه دهید. این کار شامل ارزیابی صفحه فعلی و بازسازی آن بر اساس ترکیبی از تحقیقات مستقل، مصاحبه های SME و بازخورد کاربر است. گزینه‌های ممکن شامل بازنگری در توضیحات کوتاه، ساختار مجدد صفحه موجود، و/یا افزودن لایه‌های اضافی (صفحات) از طریق یک مدل افشای اطلاعات پیشرونده است. دومی تعداد پیوندها را در صفحه فهرست اصلی کاهش می دهد تا کاربران بتوانند اطلاعات/راهنماهای خاص را پیدا کنند. به عنوان مثال، فهرست ممکن است شامل پیوندهایی به صفحات جداگانه برای طراحی و نمای کلی LLVM، راهنمای کاربر، مستندات زیرسیستم، و مستندات فرآیند توسعه باشد.
ب) راهنمای سبک LLVM Sphinx را برای مشارکت کنندگان منبع باز به روز کنید. این وظیفه شامل ارزیابی راهنمای فعلی، شناسایی شکاف ها از طریق تحقیقات مستقل و مصاحبه های SME، و به روز رسانی راهنما بر اساس الزامات مورد توافق خواهد بود. به‌روزرسانی‌ها می‌تواند شامل سازماندهی مجدد طرح راهنما، افزودن محتوای جدید، و درج پیوند به صفحات مرتبط، مانند راهنمای مشارکت‌کننده باشد. هدف نهایی این است که شروع به مشارکت در اسرع وقت برای داوطلبان آسان تر شود.