ایجاد مستندات فنی با GitHub

مدرس Michael Fawole

انتشار 2025/02/28

مدت زمان 1h 15m

سطح مناسب همه

فایل تمرینی ندارد

آموزش Creating Technical Documentation with GitHub

GitHub یک مخزن عالی برای کد است، اما از طیف گسترده ای از ابزارها برای ایجاد مستندات نیز پشتیبانی می کند. ایجاد مستندات پیچیده‌تر از استخراج نظرات از کد است و GitHub از ابزارهایی پشتیبانی می‌کند که به نویسندگان کمک می‌کند تا متن را داربست، غنی‌سازی و مدیریت کنند. در این دوره، مایکل فاوله مهارت‌های عملی را برای ارتقای فرآیند مستندسازی و افزایش کارایی تیم به اشتراک می‌گذارد - با استفاده از اسناد مانند کد. نحوه ایجاد و مدیریت محتوا با همان چارچوبی که توسعه دهندگان روزانه از آن استفاده می کنند را بیاموزید.

GitHub Knowledge Management Technical Documentation

Introduction

Getting with technical documentation in GitHub ()

1. Treating Documentation as Code

What is docs as code? ()

Benefits of docs as code ()

Common problems with traditional documentation ()

2. Tools and Technologies

Git basics for documentation ()

Installation of Git ()

Setting up a repository ()

Markdown editors ()

Version control for documentation ()

Branching and merging strategies ()

3. Writing Documentation as Code

Basic syntax and features in Markdown ()

Advanced Markdown techniques ()

Naming conventions: Part 1 ()

Naming conventions: Part 2 ()

Creating an index or table of contents ()

Invitation to try what you learned ()

4. Collaboration and Review Processes

Pull requests and code reviews ()

Best practices for collaborative documentation ()

5. Deployment

Converting docs to HTML file ()

Deployment to Vercel ()

Conclusion

Next steps ()

دانلود فایل فشرده

با توجه به امکانات آموزش و همچنین امکانات بسته انتخاب شده لینک دانلود فایل فشرده آماده خواهد شد. با در نظر داشتن این شرایط لطفا بسته مورد نظر خود را انتخاب کرده و روی دکمه درخواست لینک دانلود کلیک کنید

در حال به روزرسانی اطلاعات

درخواست لینک دانلود

در حال به روزرسانی اطلاعات

لطفا قبل از فعالسازی لینک دانلود به موارد زیر توجه کنید:

پسورد فایل‌های فشرده است.
لینک‌های آماده شده تا 8 روز پس از فعالسازی منقضی خواهند شد.
حجم فایل‌ها تخمینی هستند.
در صورتی که لینک دانلود تا 15دقیقه پس از درخواست آماده نشد، از بخش پشتیبانی پیگیری نمایید.