آموزش ایجاد مستندات فنی با GitHub - آخرین آپدیت

سرفصل ها و درس ها

مقدمه Introduction

• شروع کار با مستندات فنی در گیت‌هاب Getting with technical documentation in GitHub

1. نگاه به مستندات به مثابه کد 1. Treating Documentation as Code

• مشکلات رایج در مستندسازی سنتی Common problems with traditional documentation

• مفهوم مستندات به مثابه کد چیست؟ What is docs as code?

• مزایای رویکرد Docs as Code Benefits of docs as code

2. ابزارها و فناوری‌ها 2. Tools and Technologies

• ویرایشگرهای Markdown Markdown editors

• نصب Git Installation of Git

• مبانی گیت برای مستندسازی Git basics for documentation

• استراتژی‌های Branching و Merging Branching and merging strategies

• کنترل نسخه برای مستندات Version control for documentation

• راه‌اندازی یک مخزن (Repository) Setting up a repository

3. نوشتن مستندات به روش کدنویسی 3. Writing Documentation as Code

• سینتکس پایه و ویژگی‌های Markdown Basic syntax and features in Markdown

• ایجاد ایندکس یا فهرست مطالب Creating an index or table of contents

• تکنیک‌های پیشرفته Markdown Advanced Markdown techniques

• تمرین عملی آموخته‌ها Invitation to try what you learned

• قواعد نام‌گذاری: بخش دوم Naming conventions: Part 2

• قواعد نام‌گذاری: بخش اول Naming conventions: Part 1

4. فرآیندهای همکاری و بازبینی 4. Collaboration and Review Processes

• بهترین روش‌ها برای مستندسازی مشارکتی Best practices for collaborative documentation

• درخواست‌های Pull Request و بازبینی کد Pull requests and code reviews

5. استقرار و انتشار 5. Deployment

• استقرار در Vercel Deployment to Vercel

• تبدیل مستندات به فایل HTML Converting docs to HTML file

جمع‌بندی Conclusion

• گام‌های بعدی Next steps