این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان منبع باز:
- BRL-CAD
- نویسنده فنی:
- sahibkaur
- نام پروژه:
- راهنمای مبتدیان برای BRL-CAD
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
راهنمای مبتدیان برای BRL-CAD
چکیده پروژه
هدف این پروژه ایجاد مستندات اختصاص داده شده به کاربرانی است که نه تنها در BRL-CAD تازه کار هستند، بلکه به منبع باز نیز مبتدی هستند.
چرا این پروژه
هنگامی که برای اولین بار از وب سایت BRL-CAD بازدید کردم، از آنجایی که من به تازگی با منبع باز و BRL-CAD آشنا شده بودم، در یک لحظه غرق حجم اطلاعات شدم. اما عمیقاً می‌دانستم که اینجا چیزهای زیادی برای یادگیری وجود دارد. بنابراین، من می‌خواستم برای کاربران جدیدی مثل من اسنادی ایجاد کنم تا از این انجمن بهره ببرند و برای شروع کار احساس راحتی کنند.
اهداف
این پروژه کاربران جدید را هدف قرار خواهد داد. بنابراین، در زیر به نکاتی اشاره می‌کنیم که هدف مستندسازی من برای دستیابی به آن است: برای اطمینان از اینکه کاربران جدید احساس راحتی می‌کنند: از آنجایی که این مستندات برای کاربران جدید نه تنها برای BRL-CAD تازه کار است، بلکه برای منبع باز نیز جدید است.
برای رسیدن به این هدف، من:
- اطمینان حاصل کنید که نمره Flesch-Kincaid سند را حداقل بالای 50 نگه دارید. طبق روش Flesch-Kincaid، هر چه امتیاز بالاتر باشد، درک مطلب آسان تر است. می توانید امتیاز خوانایی آن را به صورت آنلاین بررسی کنید.
- از فهرست‌های گلوله‌دار یا شماره‌دار استفاده کنید تا خوانندگان از پاراگراف‌های طولانی خسته نشوند یا حواسشان پرت نشود.
- از پاراگراف ها و جملات کوتاه تر استفاده کنید زیرا خواندن و درک جملات طولانی تر به کار ذهنی نسبتاً بیشتری نیاز دارد.
- برای شکستن متن از عناوین فرعی استفاده کنید. مستندسازی با ساختار خوب: مستندات ساختاریافته نقش مهمی در هدایت کاربران جدید دارد. از گم شدن آنها جلوگیری می کند و به آنها اطلاع دهید که به کجا می روند و چه می کنند. برای رسیدن به این هدف، من یک نقشه ذهنی تقریبی ساخته‌ام که می‌تواند به ما کمک کند این راهنمای مبتدی را به روشی سازمان‌یافته مستند کنیم.
شرح پروژه
این پروژه بر روی نوشتن مستندات برای کاربران جدید تمرکز دارد تا بتوانند این نرم افزار را به دست بگیرند.
در زیر مثالی از نحوه توصیفی تر کردن مستندات ارائه شده است.
مقدمه اصلی: BRL-CAD (تلفظ be-are-el-cad) یک طراحی هندسه جامد سازنده (CSG) مدل سازی جامد به کمک کامپیوتر (CAD) است. این یک سیستم مدل سازی جامد قدرتمند، چند پلتفرمی و منبع باز برای طراحی سه بعدی به کمک کامپیوتر و تجسم گرافیکی است. نمی توانی سرت را دور بزنی؟ بیایید آن را تجزیه کنیم. منبع باز: نرم افزار منبع باز نرم افزاری با کد منبع است که هر کسی می تواند آن را بررسی، اصلاح و ارتقا دهد. BRL-CAD که یک نرم افزار منبع باز است، از شما استقبال می کند که مشارکت کنید و BRL-CAD را بهتر از قبل کنید! طراحی به کمک کامپیوتر (CAD): به عبارت ساده، CAD استفاده از برنامه های کامپیوتری برای ایجاد نمایش گرافیکی دو یا سه بعدی از اشیاء فیزیکی است. سیستم مدلسازی جامد: BRL-CAD بر روی CAD مدلسازی جامد تمرکز دارد. مدل سازی جامد با تأکید بر دقیق بودن فیزیکی و توصیف کامل فضای سه بعدی از سایر اشکال مدل سازی هندسی متمایز می شود. این یک شی را هم به صورت داخلی و هم خارجی شبیه سازی می کند. هندسه جامد سازنده (CSG): CSG اجازه می دهد تا مدل های پیچیده را به عنوان یک سری عملیات بولی بین اولیه ها نشان دهد. ساده ترین اجسام جامد که برای نمایش استفاده می شوند، اولیه نامیده می شوند. برای درک CSG در سطح اساسی، از اینجا دیدن کنید.
*همانطور که در توضیحات ایده پروژه ذکر شد: مستندات حداقل شامل نصب اولیه، شرح کلی قابلیت ها، اصول مدل سازی BRL-CAD، استفاده اولیه از ابزارهای اصلی، مدل سازی، واردات/صادرات، تحلیل و رندر می شود.
مقدمه های کوتاهی در مورد نحوه پوشش هر بخش در مستندات در ردیف قرار گرفته است.
- نصب اولیه: یک آموزش گام به گام برای نصب نرم افزار BRL-CAD به همراه اسکرین شات های مورد نیاز اضافه می کنم. آموزش برای مبتدیان مکان خوبی برای شروع کاربران جدید است. برخی از چیزهایی که من گم شده ام عبارتند از:
- مراحل این آموزش مبتدی به صورت گلوله ای یا شماره گذاری نشده است. داشتن یک آموزش گام به گام با اسکرین شات در پایان هر مرحله باعث می شود که کاربر بیشتر به این آموزش گره بخورد.
- شرح کلی قابلیت ها: این بخش شامل تمام قسمت هایی است که BRL-CAD قدرت نشان دادن شگفتی ها را دارد. یک رویکرد نموداری راه بهتری برای جلب توجه به این بخش خواهد بود.
- اصول مدلسازی BRL-CAD: این بخش به توضیح بیشتری نیاز دارد، زیرا کاربر پس از درک کامل این اصول مدلسازی می‌تواند BRL-CAD را بهتر درک کند.
- استفاده اولیه از ابزارهای اصلی: در این قسمت، آموزش های جداگانه ای از ابزارهای اصلی و کاربرد اصلی آنها خواهیم داشت. این آموزش های گام به گام خواهد بود.
- صادرات/واردات: کاربران با کتابخانه تبدیل هندسه آشنا خواهند شد. یکی از رایج ترین کاربردهای BRL-CAD تبدیل هندسه از یک فرمت به فرمت دیگر است. در این بخش، مبدل های صادرات و واردات را مورد بحث قرار می دهیم.
- رندر: ما اصول اولیه رندر و نیاز به آن را در نرم افزار خود پوشش خواهیم داد. کاربران همچنین با نحوه رندر کردن تصاویر در BRL-CAD آشنا خواهند شد.
علاوه بر آن، تمرکز بر موارد زیر نیز می باشد:
- ابتدای مستندات، درک اولیه ای از این نرم افزار خواهد داشت.
- چگونه کاربران می توانند با این جامعه منبع باز ارتباط برقرار کنند. پیوند به چت zulip BRL-CAD.
- در سطحی انتزاعی، مستندات را کمی طنزآمیز کنید و از کاربران جدید بخواهید که با کلمات بزرگ دلسرد نشوند. من رویکرد همدلانه مورد استفاده در صفحه اصلی ویکی BRL-CAD را دوست داشتم.
- این برنامه دارای اسکرین شات هایی از کارهای شگفت انگیزی است که کاربران می توانند با استفاده از این نرم افزار انجام دهند.
نقاط عطف
جولای (دوره بررسی پیشنهاد)
- من با مرور آموزش های موجود خود را با نرم افزار و ویکی اسناد آن بیشتر آشنا خواهم کرد.
- من بهبودهایی را در اسناد موجود انجام خواهم داد.
1 اوت - 7 اوت (پیوند جامعه)
- بحث و گفتگو با مربیان در مورد پروژه
- اصلاح جزئیات پروژه
- تغییرات لازم را در نقاط عطف (در صورت نیاز) ایجاد کنید.
8 آگوست - 14 آگوست
- با Docbook XML آشنا شوید
15 اوت - 21 اوت
- نوشتن مستندات برای "مقدمه اولیه بر BRL-CAD"
- نوشتن آموزش گام به گام "نصب پایه"
22 اوت - 27 اوت
- بررسی قابلیت های مختلف BRL-CAD و فهرست کردن آنها به همراه تصاویر.
- ویژگی های فردی را در یک صفحه جداگانه توضیح دهید.
28 اوت - 3 سپتامبر
- به کار بر روی اسناد فردی برای قابلیت ها ادامه دهید.
4 سپتامبر - 10 سپتامبر
- کار بر روی اصول مدلسازی
- توضیح کلیه اصول مدلسازی
11 سپتامبر - 17 سپتامبر
- روی استفاده اساسی از ابزارهای اصلی کار کنید.
- فهرست کوتاه ایده ها برای مستند کردن استفاده اساسی از هر ابزار.
18 سپتامبر - 24 سپتامبر
- مستندسازی استفاده از هر ابزار
25 سپتامبر - 1 اکتبر
- روی Modeling کار کنید تا یک مدل جامد برای آموزش ایجاد کنید و در کنار آن یک پیش نویس بنویسید.
2 اکتبر - 8 اکتبر
- پیش نویس مدل سازی را بهبود بخشید.
2 اکتبر - 8 اکتبر
- مطالعه مبدل های صادرات و واردات.
9 اکتبر - 15 اکتبر
- اسناد صادرات و واردات را آماده کنید.
- شروع به کار بر روی رندر کنید.
16 اکتبر - 22 اکتبر
- مستندسازی آموزش رندر.
23 اکتبر - 29 اکتبر
- بررسی تمام اسناد
30 اکتبر - 5 نوامبر
- کار بر روی Docbook XML
6 نوامبر - 12 نوامبر
- از مربیان و سایر اعضای جامعه نظر بخواهید و روی تغییرات کار کنید.
- بحث با مربیان و ایجاد تغییرات نهایی.
12 نوامبر - 22 نوامبر
- فرآیند بحث و تغییر
- لمس نهایی به مستندات.
درمورد من
من از دوران مدرسه وارد نوشتن شدم. از مدرسه به خانه می آمدم و همه چیز را درباره روزم می نوشتم. چه چیزی روزم را بهتر یا بدتر کرد من همیشه مشتاق بودم که اشتباهاتی را که مرتکب شدم بنویسم و چگونه می توانم آنها را بهبود بخشم.
در طول دوره آموزشی من به عنوان یک طراح وب، از ما خواسته شد تا آنچه را که روزانه یاد می گیریم، یادداشت کنیم. من برخی از مشکلاتی که با آن روبرو بودم و راه حل آن را مستند می کنم.
من به عنوان یک فرد، همیشه بهترین تلاشم را برای کمک به دیگران می گذارم. در روزهای مدرسه و دانشگاه، بعد از اینکه خودم آن موضوعات را فهمیدم، برخی از موضوعات را برای دوستانم توضیح می دادم. شرکت در GSoD گامی باشکوه است که از طریق آن من به عنوان نویسنده می‌توانم در جذاب‌تر کردن این جامعه منبع باز برای کاربران جدید در سراسر جهان کمک کنم.