این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان منبع باز:
- زبان جولیا
- نویسنده فنی:
- sophb
- نام پروژه:
- اختراع مجدد وب سایت FluxML
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
هدف این پیشنهاد بهبود وب‌سایت مستندات Flux است تا اطلاعاتی که در آن وجود دارد ساختارمند و جذاب برای تازه واردان و متخصصان باشد. به طور خاص، هدف، سازماندهی مجدد اسناد موجود در بخش‌های جدید و ایجاد یک آموزش شروع جدید برای تازه واردان است که آموزش Flux 60-mine-blitz را گسترش می‌دهد.
این پروژه شامل مراحل زیر است:
تجزیه و تحلیل وب سایت مستندات فعلی: اطلاعات موجود را بررسی کنید و یک راهنمای سبک (برای اطلاعات) برای ایجاد آموزش های جدید تعریف کنید.
تعریف یک ساختار جدید برای اطلاعات و آموزش شروع: برای تعیین بخش های جدید و سازماندهی مجدد وب سایت مستندسازی با مربیان کار کنید. همچنین، با استفاده از آموزش Flux 60-mine-Blitz به عنوان نقطه شروع، فهرستی از مطالب را برای آموزش شروع تعریف کنید و بر اساس آن بسازید.
تغییر ساختار اطلاعات: وب سایت را با طرحی که با همکاری مربیان در مرحله قبل تعریف شده است، به روز کنید.
ایجاد آموزش شروع: اولین پیش نویس را بنویسید و آن را مرور کنید. از مربیان بازخورد دریافت کنید. وقتی من و مربیان تشخیص دادیم که نسخه نهایی این سند را داریم، آن را در وب سایت مستندسازی منتشر خواهم کرد.
(اختیاری) تبدیل اسناد موجود در قالب README به HTML: اگر پس از تکمیل چهار مرحله اصلی مدتی باقی مانده است، می توانم آموزش های موجود را که README هستند تبدیل کنم تا دسترسی به آنها از وب سایت آسان تر باشد.
برای دستیابی به هدف پروژه، من از نزدیک با جامعه Flux کار خواهم کرد تا اسناد موجود را درک کرده و بهترین رویکرد را تعیین کنم. من خودم تازه وارد جولیا هستم و معتقدم این در تعیین سطح مناسب اطلاعات برای آموزش شروع جدید بسیار مفید خواهد بود.
من بر این تمرکز خواهم کرد که مطمئن شوم کارم به جامعه Flux کمک می‌کند تا در استفاده‌های جدید استفاده کند. همچنین، من بر کمک به کاربران با تجربه برای کشف موارد استفاده جدید و کشف جزئیات دقیق Flux تمرکز خواهم کرد.