این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه پروژه
- سازمان منبع باز:
- جانگو
- نویسنده فنی:
- گبی گرانبها
- نام پروژه:
- راهنمای مشارکت را بازنویسی کنید تا کاربر پسندتر باشد و به راحتی قابل پیمایش باشد
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
چکیده
هدف از راهنمای مشارکت جنگو مانند سایر اسناد، راهنمایی کاربران و مشارکت کنندگان منبع باز در این مورد است که چگونه و کجا می توانند در ساخت جنگو بهتر و پایدار کمک کنند.
همیشه نیاز به تهیه اسنادی وجود دارد، به خصوص اسنادی که به شدت بر جامعه و خود جنگو تأثیر می گذارد.
هدف Django برای تابستان Google Docs امسال این است که راهنمای مشارکت را برای مشارکت‌کنندگان کمتر فراگیر، در دسترس و خوشایند کند. این هدفی است که ضروری است زیرا مشارکت‌کنندگانی را تشویق می‌کند که من خودم برای شروع به مشارکت در این چارچوب عالی به آن تعلق دارم.
وضعیت فعلی
مرحله کنونی مستنداتی که در اینجا یافت می شود، واقعاً راهنما نیست، زیرا بسیار زیاد است و ساختار خوبی ندارد و منجر به درک کمتر مشارکت در جنگو و عدم استقبال از مشارکت کنندگان جدید می شود.
اهداف پروژه
من پیشنهادات خود را برای مستندات با مربیم، کارلتون گیبسون در انجمن در میان گذاشتم و او تأیید می کند که این موضوع به مشکل بسیار زیاد مستندات فعلی کمک می کند. در اینجا اهدافی که برای دستیابی به بازسازی سند برنامه ریزی می کنم عبارتند از: ساختار مجدد سند افزودن بایدها و نبایدهای مقطعی ایجاد صفحات منفرد برای بخش های بی اهمیت مانند درخواست و ساخت ویژگی ها مستندات کاهش یافته و مستقیم به نقطه واژه نامه برای کلمات Internal Index ساخته شده برای پیروی از راهنمای جدید مستندات دوستانه مرتبط تری بنویسید و محتوا را به دو بخش اصلی تقسیم کنید (بخش مبتدیان و مشارکت کنندگان پیشرفته) ساختار راهنما و سبکی برای نویسندگان/همیاران فنی جدید، به روز نگه داشتن اسناد و پیروی از استانداردها.
مستندات فعلی در حال حاضر برای مشارکت‌کنندگان پیشرفته هدف‌گذاری شده است و به مشارکت‌کنندگان جدید و مبتدی فرصتی برای منبع باز و جنگو نمی‌دهد، در اینجا برخی از مطالب اضافی برای مبتدیان وجود دارد: بخشی که مجموعه‌ای از مشارکت‌کنندگان (نویسندگان فنی، طراحان و توسعه‌دهندگان را راهنمایی می‌کند. ) صفحه ای که مسائل مربوط به تایمر اول و مسائل آسان قابل حل را مستند می کند. چند بخش را در مستندات فعلی بردارید، بازنویسی کنید و به بخش مبتدیان اضافه کنید. بخش هایی که نکات کلیدی یا کلمات مورد استفاده در بخش پیشرفته را توضیح می دهند.
جدول زمانی
در اینجا توضیحی در مورد نحوه کار من بر روی هدف پروژه همانطور که در بالا با تقویم ارائه شده توسط Google ذکر شده است ارائه خواهد شد.
هفته پیوند جامعه (17 اوت تا 13 سپتامبر) با جامعه بیشتر درگیر شوید ادامه مشارکت در مستندات دریافت پیشنهادات بیشتر از مشارکت کنندگان مطالعه بیشتر اسناد فعلی و ابزارهای مورد نظر هفته 1 - هفته 4 شروع به تقسیم اسناد بر اساس سطوح ایجاد کنید بخش مبتدیان از مستندات هفته 4 - 6 تنظیم بایدها و نبایدها نوشتن قسمتی بایدها و نبایدها صفحات اضافی برای بخش‌های هفته 7 - 9 بازنویسی و انتقال اسناد فعلی به راهنمای مشارکت‌کننده پیشرفته مستندات کاهش‌یافته هفته 10 - 12 آماده‌سازی به‌روزرسانی واژه‌نامه فهرست داخلی برای مستندات جدید ایجاد راهنما و سبک برای نویسندگان/همیاران فنی ورودی
ابزار
ابوالهول - ابزار فعلی برای اسناد فعلی. Docs را بخوانید.
چرا این پروژه؟
من اعتقاد اصلی به اسناد و مقالات خوب نوشته شده دارم تا همه را در بخشی از جهان تحت پوشش قرار دهم. جدای از آن، من همچنین عاشق جنگو و منبع باز هستم. من قصد داشتم به عنوان یک مبتدی به جنگو کمک کنم و فکر می کنم این یک راه عالی برای کمک به ابزار مورد علاقه من است، در حالی که با پایگاه کد آشنا می شوم تا به عنوان یک توسعه دهنده (و یک نویسنده فنی) مشارکت بیشتری داشته باشم. کار با سازمانی که با دیدگاه های من همسو باشد و ابزاری عالی برای تمام حرفه من بوده، خوشایند و زیبا خواهد بود.
چرا من شخص مناسبی برای این پروژه هستم؟
من معتقدم که بر اساس حساب‌های زیر، فرد مناسبی هستم: من با نوشتن مقاله‌هایی در جنگو مشارکت داشته‌ام تا به مبتدیان کمک کنم تا مفهوم جنگو را بیشتر درک کنند. من که یک توسعه دهنده هستم و مشتاقانه منتظر مشارکت در جنگو هستم، نیاز توسعه دهندگان همکار و نحوه مستندسازی آن را به خوبی برای آنها درک می کنم. من یک بازیکن تیم هستم و تحت نظارت کمتر یا بیشتر مربی ام کارلتون گیبسون به خوبی کار خواهم کرد.