پروژه زیرساخت کامپایلر LLVM
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه پروژه
- سازمان منبع باز:
- زیرساخت کامپایلر LLVM
- نویسنده فنی:
- DR87
- نام پروژه:
- فهرست اسناد LLVM و راهنمای سبک مستندسازی را بازسازی کنید
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
این پروژه شامل وظایف زیر است:
الف) صفحه فهرست اسناد را بازسازی کنید تا تجربه کاربر پسندتری را ارائه دهید. این کار شامل ارزیابی صفحه فعلی و بازسازی آن بر اساس ترکیبی از تحقیقات مستقل، مصاحبه های SME و بازخورد کاربر است. گزینه‌های ممکن شامل بازنگری در توضیحات کوتاه، ساختار مجدد صفحه موجود، و/یا افزودن لایه‌های اضافی (صفحات) از طریق یک مدل افشای اطلاعات پیشرونده است. دومی تعداد پیوندها را در صفحه فهرست اصلی کاهش می دهد تا کاربران بتوانند اطلاعات/راهنماهای خاص را پیدا کنند. به عنوان مثال، فهرست ممکن است شامل پیوندهایی به صفحات جداگانه برای طراحی و نمای کلی LLVM، راهنمای کاربر، مستندات زیرسیستم، و مستندات فرآیند توسعه باشد.
ب) راهنمای سبک LLVM Sphinx را برای مشارکت کنندگان منبع باز به روز کنید. این وظیفه شامل ارزیابی راهنمای فعلی، شناسایی شکاف ها از طریق تحقیقات مستقل و مصاحبه های SME، و به روز رسانی راهنما بر اساس الزامات مورد توافق خواهد بود. به‌روزرسانی‌ها می‌تواند شامل سازماندهی مجدد طرح راهنما، افزودن محتوای جدید، و درج پیوند به صفحات مرتبط، مانند راهنمای مشارکت‌کننده باشد. هدف نهایی این است که شروع به مشارکت در اسرع وقت برای داوطلبان آسان تر شود.
محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است، مگر غیر از این ذکر شده باشد. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2024-11-19 بهوقت ساعت هماهنگ جهانی.
[[["درک آسان","easyToUnderstand","thumb-up"],["مشکلم را برطرف کرد","solvedMyProblem","thumb-up"],["غیره","otherUp","thumb-up"]],[["اطلاعاتی که نیاز دارم وجود ندارد","missingTheInformationINeed","thumb-down"],["بیشازحد پیچیده/ مراحل بسیار زیاد","tooComplicatedTooManySteps","thumb-down"],["قدیمی","outOfDate","thumb-down"],["مشکل ترجمه","translationIssue","thumb-down"],["مشکل کد / نمونهها","samplesCodeIssue","thumb-down"],["غیره","otherDown","thumb-down"]],["تاریخ آخرین بهروزرسانی 2024-11-19 بهوقت ساعت هماهنگ جهانی."],[[["This project aims to improve the LLVM documentation by restructuring its index page for better user experience and updating the style guide to facilitate easier contributions."],["The project involves researching, interviewing subject matter experts, and incorporating user feedback to enhance the organization and accessibility of LLVM documentation."],["Improvements to the documentation index page may include revising descriptions, restructuring content, and implementing a progressive disclosure model for easier navigation."],["Updates to the Sphinx style guide will focus on clarity, comprehensiveness, and providing resources for open-source contributors to quickly get started."],["The project is part of Google Season of Docs and will be completed within a standard timeframe of 3 months by technical writer DR87."]]],["The project aims to improve the LLVM documentation's accessibility and usability. Key actions include restructuring the documentation index page for a better user experience, possibly adding new layers and revising descriptions. Another focus is updating the LLVM Sphinx style guide by identifying gaps, reorganizing the layout, adding new content, and including relevant links to streamline the contribution process for open-source volunteers. The project will involve research, expert interviews, and user feedback.\n"]]
