این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان منبع باز:
- CircuitVerse
- نویسنده فنی:
- پراگاتی
- نام پروژه:
- مستندات و راهنمای کاربر
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
پس از انجام یک تجزیه و تحلیل عمیق از مخاطبان و مستندات موجود کاربر فعلی، وظایف مستندسازی زیر را پیشنهاد می کنم:
1) آموزش های ویدیویی را برای نشان دادن گردش های کاری محبوب و بهبود تجربه سوار شدن اضافه کنید. ویدئوها یک مفهوم واحد را ترسیم می کنند. هنگام انجام آن عمل روی صفحه، ویدیوها جهت می دهند.
نمونه لینک آموزش تصویری استفاده از ابزار تحلیل ترکیبی را می توانید در اینجا بیابید. https://www.youtube.com/watch?v=7FkeqBYcd1w نکته 1 : در حالی که این ویدیو محتوای موجود را نمونه می‌کند، اما هدف آن نشان دادن سبک نحوه استفاده از حاشیه‌نویسی برای ایجاد یک سبک ویدیویی ثابت است. نکته 2 : زمانی که من برای CircuitVerse شروع به کار می کنم، مجوز نرم افزار را خریداری می کنم و محصول نهایی شامل واترمارک نخواهد بود.
عناوین پیشنهادی برای گردش کارهای آموزشی ویدیویی: --شروع کار با CircuitVerse: این آموزش ویدیویی را برای بازدید سریع از CircuitVerse تماشا کنید --استفاده از ابزار تجزیه و تحلیل ترکیبی: برای یادگیری نحوه تولید مدارها با استفاده از داده های جدول حقیقت، این آموزش ویدیویی را تماشا کنید. --صادرات تصاویر با وضوح بالا: این آموزش ویدیویی را تماشا کنید تا یاد بگیرید چگونه تصاویر با وضوح بالا از مدارهای خود را در فرمت های مختلف صادر کنید -- استفاده از مدارهای فرعی برای طراحی ساختاریافته: برای یادگیری نحوه ایجاد مدارهای فرعی برای ساده سازی ساختار پیچیده، این آموزش ویدیویی را تماشا کنید. مدارها --استفاده از ابزار تبدیل Hex-Bin-Dec: برای یادگیری نحوه استفاده از ابزار تبدیل Hex-Bin-Dec برای طراحی و پیاده سازی مدار، این آموزش ویدیویی را تماشا کنید. - تجسم نمودارهای زمان بندی مدار برای یک مدار معین: این آموزش ویدیویی را تماشا کنید تا یاد بگیرید که چگونه کاربران می توانند نمودار زمان بندی مدار را برای یک مدار معین تجسم کنند.
برخی از آموزش های ویدئویی را می توان در صفحات وب و مستندات کاربر به هم مرتبط کرد.
2) یک صفحه فرود آموزشی ایجاد کنید تا یک نمای کلی از پلتفرم CircuitVerse و همچنین یک نمای گرافیکی از گردش های کاری مختلف ارائه دهید. کاربران به صفحه فرود آموزشی در سایت Circuitverse GitHub دسترسی خواهند داشت که خلاصه ای از آموزش های مختلف ارائه شده برای جریان های کاری محتوای مختلف را ارائه می دهد. این به کاربر امکان مشاهده و انتخاب آموزش های مختلف را برای نیازهای خود می دهد. در زیر یک نمونه تقریبی از ساختار صفحه صفحه فرود آموزشی آورده شده است.
3) آموزش های گام به گام ایجاد کنید تا به کاربران آموزش دهید که چگونه می توانند از ابزار برای یادگیری و تجزیه و تحلیل رفتار مدارهای اولیه و پیچیده استفاده کنند – ابزار را با بازی با ابزار آموزش دهید. با اشاره به پروژه‌های ویژه CircuitVerse، پیشنهاد می‌کنم حداقل 5 آموزش برای کاربران سطح مبتدی و متوسط برای بهبود تجربه ورود اضافه شود. با نشان دادن یک گردش کار کامل، هر آموزش مقدمه ای بر آموزش ارائه می دهد و پس از آن یک فرآیند طراحی، لیست اجزا، دستورالعمل های گام به گام و تمرینات تمرینی ارائه می شود. برای گردش‌های کاری پیچیده، ویدیوها بخشی از یک مفهوم کلی را پوشش می‌دهند.
برای مشاهده نمونه آموزش به این لینک مراجعه کنید: ساخت رسیور هفت بخش: https://pragatijain.github.io/circuitverse/index.html
برخی از موضوعات عبارتند از: -- ساخت یک نمایشگر LED نورد -- بررسی نحوه عملکرد جمع کننده حمل موج دار -- قسمت 1A: تجزیه و تحلیل یک مقایسه کننده بزرگی 4 بیت -- قسمت 1B: ساخت ماشین حساب هگزادسیمال -- تجزیه و تحلیل یک ماشین حالت محدود ( پیاده سازی FSM).
4) ساختار ناوبری نوار کناری را برای بهبود سازگاری، خوانایی و انسجام اصلاح کنید.
ابزار پروژه 1) Camtasia برای آموزش های ویدئویی. من از نسخه آزمایشی برای ساخت ویدیوی نمونه استفاده کرده ام. هنگامی که کار را برای CircuitVerse شروع می کنم، مجوزی برای نرم افزار خریداری می کنم و محصول نهایی شامل واترمارک نخواهد بود. 2) Google Docs برای نوشتن راهنماهای من که بعداً در GitHub به روز خواهم کرد تا در مخزن CircuitVerse میزبانی کنم. 3) نشانه گذاری ویکی و HTML برای مدیریت محتوای من در GitHub.
جدول زمانی قبل از 16 آگوست در GitHub به سازمان کمک کنید.
پیوند جامعه (17 اوت - 13 سپتامبر) یک کانال ارتباطی و زمان ایجاد کنید (به دلیل اختلاف زمانی). اهدافم را اصلاح کنم و انتظاراتم را از هر دو طرف مشخص کنم. درباره جامعه و محصول بیشتر بدانید. ساختار اسناد پیشنهادی را با مربیان و سایر اعضای سازمان مورد بحث و بررسی قرار دهید و نهایی کنید.
دوره مستندسازی این پروژه از دستورالعمل های پروژه با طول استاندارد پیروی می کند (در مجموع 11 هفته، از 9/14/2020 تا 11/30/2020). من حدود 20 ساعت در هفته را صرف تکمیل اهدافی خواهم کرد که در زیر به آنها اشاره شده است. علاوه بر این اهداف، در این مدت در صورت نیاز در جلسات و ارتباطات راهنما شرکت خواهم کرد. من با مربیان کار خواهم کرد تا بهترین زمان را برای این کار تعیین کنیم. توجه: این جدول زمانی منعطف است و این واقعیت را تشخیص می دهد که نیازهای سازمانی می توانند تغییر کنند. تایم فریم های بزرگ به انعطاف پذیری و توانایی تغییر فوکوس در صورت نیاز اجازه می دهد.
هفته 1: نقاط عطف شناسایی شده را مرور کنید و مخزن Fork CircuitVerse را اصلاح کنید و آن را در دستگاه من دانلود کنید. با مربیان درباره سبک ویدیوها بحث کنید، همچنین یک الگوی صفحه باز کردن ویدیو، هر موسیقی پرکننده برای صفحه عنوان و صفحه پایانی، و اطلاعات اضافی ایجاد کنید. باید گنجانده شود. بررسی موضوعات آموزشی ویدئویی و تایید آن موضوعات آموزشی را شناسایی کرده و تایید آن را دریافت کنید. ساختار ناوبری نوار کناری را بررسی کنید و آن را تأیید کنید
هفته 2: ساخت قالب آموزشی و تایید آن توسط مربی ایجاد صفحه فرود آموزش برای میزبانی آموزش ها
هفته 3، 4، 5: آموزش های ویدیویی را برای نشان دادن جریان های کاری شبیه ساز مختلف اضافه کنید
هفته 6، 7، 8، 9: آموزش هایی برای مدارهای مختلف ساده و پیچیده ایجاد کنید
هفته 10: ناوبری نوار کناری را برای یکپارچگی برای بهبود تجربه ورود کاربر بازسازی کنید
هفته یازدهم: کارهای من را برای اشتباهات تایپی و اشتباهات تصحیح کنید.
نمونه کار CircuitVerse مربوطه
*برای مشاهده نمونه آموزش ساخت رسیور هفت بخش به این لینک مراجعه کنید. : https://pragatijain.github.io/circuitverse/index.html
*نمونه لینک آموزش تصویری استفاده از ابزار تحلیل ترکیبی را می توانید در اینجا بیابید. https://www.youtube.com/watch?v=7FkeqBYcd1w نکته 1 : در حالی که این ویدیو محتوای موجود را نمونه می‌کند، اما هدف آن نشان دادن سبک نحوه استفاده از حاشیه‌نویسی برای ایجاد یک سبک ویدیویی ثابت است. نکته 2 : زمانی که من برای GDevelop کار می کنم، مجوز نرم افزار را خریداری می کنم و محصول نهایی شامل واترمارک نخواهد بود.
*صفحه فرود آموزش CircuitVerse https://docs.google.com/document/d/1sBKS2cq76zRHDGgA2Lbf7isSisRK_ELLSPsg-7atCAI/edit#
*مشاهده پیشنهاد کامل به عنوان یک سند گوگل: https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#
نمونه قالب آموزشی: 7 Segment Decoder 7 Segment Decoder
بررسی اجمالی:
این آموزش مراحل مختلف ایجاد رمزگشای 7 سگمنت را با استفاده از CircuitVerse با شما به اشتراک می گذارد. رمزگشا یک مدار ترکیبی است که یک عدد باینری را به عدد اعشاری مربوطه تبدیل می کند. چهار بیت ورودی می گیرد و هفت خروجی دارد.
رویه طراحی
برای تولید مدار نمایشگر 7 بخش در CircuitVerse، مراحل زیر را دنبال می کنیم: از ابزار تحلیل ترکیبی موجود در شبیه ساز CircuitVerse برای فرمول بندی جدول حقیقت استفاده کنید. با استفاده از این جدول حقیقت، مدار را در شبیه ساز تولید می کنیم. این مدار خروجی را به یک صفحه نمایش LED هفت بخش هدایت می کند. برچسب های مربوطه مدار ترکیبی را به خروجی های مربوطه نمایشگر LED هفت بخش وصل کنید تا مدار خود را در حال عمل ببینید. نمایشگر هفت بخش یک دستگاه نمایشگر الکترونیکی برای نمایش اعداد اعشاری از 0 تا 9 است. رجوع کنید رفتار مدار را با استفاده از داده های جدول صدق تجزیه و تحلیل کنید. جدول حقیقت جدول 1 زیر خروجی های مختلف را برای ترکیب های مختلف ورودی برای رمزگشای 7 سگمنت فهرست می کند.
فهرست عناصر CircuitVerse
جدول 2 اجزای مختلف مورد نیاز برای اجرای مدار را فهرست می کند.
جدول حقیقت را فرموله کنید
مراحل زیر را برای فرمول بندی جدول صدق در شبیه ساز CircuitVerse دنبال کنید:
مدار را کامل کنید
به شکل 10 مراجعه کنید تا سیم های ورودی مربوطه را برای برچسب های متناظر مدار ترکیبی به خروجی های مربوطه نمایشگر هفت بخش وصل کنید تا مدار کامل شود. این ویدئو یک مدار شبیه‌سازی شده رمزگشای 7 بخش ساخته شده در شبیه‌ساز CircuitVerse را نشان می‌دهد. لینک ویدیو: https://www.youtube.com/embed/tGTy4P-RxP0
مدار را آنالیز کنید
مقادیر ورودی مختلف (S3، S2، S1، S0) را تغییر دهید و جدول حقیقت را تأیید کنید (به جدول 1 مراجعه کنید) تا مدار رمزگشای هفت بخش اجرا شده را تأیید کنید.
یک جزء نمایشگر هفت بخش دارای 8 بخش LED در داخل خود است و یک انتهای پین های آنها همانطور که در شکل 8 نشان داده شده است از ماژول بیرون کشیده شده است. d, e, f, g در شکل 10) باید برای نمایش اعداد 0 تا 9 روشن شوند. به عنوان مثال، برای نمایش عدد 1، LED b و c باید روشن شوند.
اگر LED عدد اعشاری درست را نشان نداد، به جدول 3 و شکل 10 مراجعه کنید و اتصالات سیم کشی خود را عیب یابی کنید. جدول 3 پیکربندی پین نمایش 7 قسمتی را فهرست می کند.