دوره آموزشی ایجاد مستندات فنی با استفاده از GitHub
1 ساعت 11 دقیقهمتوسط2025-02-28
مدرسین

Michael Fawole
جزئیات دوره
GitHub فقط برای نگهداری کدهات نیست! این پلتفرم ابزارهای خیلی خوبی برای ساخت و مدیریت مستندات هم داره. اما نوشتن مستندات فقط این نیست که کامنتها رو از توی کد بکشی بیرون! این کار یه فرآیند کامل و حرفهایه. GitHub ابزارهایی ارائه میده که بهت کمک میکنه مستندات رو حرفهای و قابل مدیریت تولید و بهروزرسانی کنی.
توی این دوره، «مایکل فاول» بهت یاد میده چطور مثل یه برنامهنویس حرفهای، به مستندسازی نگاه کنی—یعنی مستندات رو هم مثل کد بنویسی، تغییر بدی و با تیم شیر کنی. از ابزارهایی که برنامهنویسا هر روز باهاشون کار میکنن، استفاده میکنیم تا روند مستندسازی هم بشه بخشی از جریان توسعه نرمافزار.
یاد میگیری چطور مستندات رو با گیت و سیستمهای کنترل نسخه مدیریت کنی، چطوری با نویسندهها و برنامهنویسها همکاری بهتری داشته باشی، و مستندات فنی رو به صورت ساختیافته، کامل و قابل ردیابی بنویسی.
🎯 اهداف یادگیری:
یاد گرفتن اینکه چطور مستندسازی رو مثل کدنویسی انجام بدی.
یکپارچه کردن مستندسازی با فرآیند توسعه نرمافزار (DevOps-style).
ساخت، ویرایش و مدیریت مستندات با ابزارهایی مثل Git، Markdown و GitHub.
همکاری همزمان بین برنامهنویسها و نویسندهها روی مستندات.
مدیریت تیمی که هم دولوپر داره هم نویسنده فنی، با یه سبک کاری یکپارچه.
توی این دوره، «مایکل فاول» بهت یاد میده چطور مثل یه برنامهنویس حرفهای، به مستندسازی نگاه کنی—یعنی مستندات رو هم مثل کد بنویسی، تغییر بدی و با تیم شیر کنی. از ابزارهایی که برنامهنویسا هر روز باهاشون کار میکنن، استفاده میکنیم تا روند مستندسازی هم بشه بخشی از جریان توسعه نرمافزار.
یاد میگیری چطور مستندات رو با گیت و سیستمهای کنترل نسخه مدیریت کنی، چطوری با نویسندهها و برنامهنویسها همکاری بهتری داشته باشی، و مستندات فنی رو به صورت ساختیافته، کامل و قابل ردیابی بنویسی.
🎯 اهداف یادگیری:
یاد گرفتن اینکه چطور مستندسازی رو مثل کدنویسی انجام بدی.
یکپارچه کردن مستندسازی با فرآیند توسعه نرمافزار (DevOps-style).
ساخت، ویرایش و مدیریت مستندات با ابزارهایی مثل Git، Markdown و GitHub.
همکاری همزمان بین برنامهنویسها و نویسندهها روی مستندات.
مدیریت تیمی که هم دولوپر داره هم نویسنده فنی، با یه سبک کاری یکپارچه.
مهارت ها
Enterprise Content ManagementVersion ControlGitHubSoftware Development ToolsNetwork and System AdministrationSoftware DevelopmentOne-Off
سرفصل ها
0. مقدمه
- 01 - دریافت اسناد فنی در GitHub
1. در نظر گرفتن اسناد به عنوان کد
- 02 - Docs به عنوان کد چیست
- 03 - مزایای اسناد به عنوان کد
- 04 - مشکلات رایج در اسناد سنتی
2. ابزارها و فن آوری ها
- 05 - اصول Git برای مستندسازی
- 06 - نصب Git
- 07 - راهاندازی یک مخزن
- 08 - ویراستاران Markdown
- 09 - کنترل نسخه برای مستندات
- 10 - راهبردهای انشعاب و ادغام
3. نوشتن اسناد به عنوان کد
- 11 - نحو و ویژگیهای اولیه در Markdown
- 12 - تکنیکهای پیشرفته Markdown
- 13 - قراردادهای نامگذاری - قسمت 1
- 14 - قراردادهای نامگذاری - قسمت 2
- 15 - ایجاد فهرست یا فهرست مطالب
- 16 - دعوت به امتحان آنچه آموختید
4. فرآیندهای همکاری و بررسی
- 17 - درخواستها و بررسی کدها را بکشید
- 18 - بهترین شیوهها برای مستندسازی مشارکتی
5. استقرار
- 19 - تبدیل اسناد به فایل HTML
- 20 - استقرار به Vercel
نتیجه گیری
- 21 - مراحل بعدی
دوره های مرتبط
- دوره آموزشی استفاده از Microsoft Syntex برای مدیریت اطلاعات هوش مصنوعی در شیرپوینت
- دوره آموزشی جریان داده مایکروسافت فابریک و ذخیره سازی داده ها
- دوره آموزشی یادگیری جامع شیرپوینت آنلاین: اصول
- دوره آموزشی پادکست برای شرکت ها
- دوره آموزشی یکربندی و مدیریت Microsoft SharePoint Online
- دوره آموزشی شیرپوینت: سفارشی سازی سایت
- دوره آموزشی یادگیری جامع اصول اولیه شیرپوینت آنلاین (2022)
- دوره آموزشی خدمات مشتری: مدیریت دانش