دوره آموزشی یادگیری API Documentation با JSON و XML
1 ساعت 19 دقیقهمتوسط2017-01-30
مدرسین

Peter Gruenbaum
Computer Programmer, Technical Writer
جزئیات دوره
تو این دوره یاد میگیری چطوری دادههایی که از طریق وب APIها ارسال و دریافت میشن رو به صورت دقیق و قابل فهم مستند کنی تا توسعهدهندهها بتونن راحتتر برنامههایی بسازن که بتونن از این دادهها درست استفاده کنن.
پیتر گرونبام، کارشناس برنامهنویسی و نویسندگی فنی، میدونه که APIها روزبهروز اهمیت بیشتری پیدا میکنن. به همین دلیل تو این آموزش، روش مستندسازی دادههای ساختارمند رو با فرمتهای رایج تبادل داده بهت یاد میده تا مهارتهای پایه و محکم تو مستند کردن APIها بدست بیاری.
پیتر مزایای مستندات خوب رو توضیح میده، تفاوت درخواستها (requests) و پاسخها (responses) رو برات روشن میکنه و یاد میگیری چطوری با انواع دادههای متداول مثل عدد، متن، آرایه و دیکشنری کار کنی.
بعدش، یاد میگیری چطوری دادههای ساختارمند رو با فرمتهای محبوب JSON و XML ایجاد و مستندسازی کنی.
دوره رو با بررسی مزایا و معایب ابزارهای مختلف مستندسازی و همکاری مثل ویکیها و پایگاههای دانش تموم میکنه.
اهداف یادگیری دوره
✅ آشنایی با هدف مستندسازی API
✅ شناخت انواع دادههای رایج
✅ کار با دادههای ساختارمند
✅ نوشتن و مستندسازی JSON
✅ نوشتن و مستندسازی XML
✅ آشنایی با زبان Markdown
✅ مستندسازی پاسخهای JSON ساده و تو در تو
✅ مستندسازی ویژگیها و نمونههای XML
✅ ساختاردهی مستندات دادهها
پیتر گرونبام، کارشناس برنامهنویسی و نویسندگی فنی، میدونه که APIها روزبهروز اهمیت بیشتری پیدا میکنن. به همین دلیل تو این آموزش، روش مستندسازی دادههای ساختارمند رو با فرمتهای رایج تبادل داده بهت یاد میده تا مهارتهای پایه و محکم تو مستند کردن APIها بدست بیاری.
پیتر مزایای مستندات خوب رو توضیح میده، تفاوت درخواستها (requests) و پاسخها (responses) رو برات روشن میکنه و یاد میگیری چطوری با انواع دادههای متداول مثل عدد، متن، آرایه و دیکشنری کار کنی.
بعدش، یاد میگیری چطوری دادههای ساختارمند رو با فرمتهای محبوب JSON و XML ایجاد و مستندسازی کنی.
دوره رو با بررسی مزایا و معایب ابزارهای مختلف مستندسازی و همکاری مثل ویکیها و پایگاههای دانش تموم میکنه.
اهداف یادگیری دوره
✅ آشنایی با هدف مستندسازی API
✅ شناخت انواع دادههای رایج
✅ کار با دادههای ساختارمند
✅ نوشتن و مستندسازی JSON
✅ نوشتن و مستندسازی XML
✅ آشنایی با زبان Markdown
✅ مستندسازی پاسخهای JSON ساده و تو در تو
✅ مستندسازی ویژگیها و نمونههای XML
✅ ساختاردهی مستندات دادهها
مهارت ها
XMLJSONAPIsFront-End Web DevelopmentLearningWeb DevelopmentProgramming LanguagesOpen SourceSoftware Development
سرفصل ها
مقدمه ای بر اسناد JSON و XML
- 01 - خوش آمدید
- 02 - آنچه باید بدانید
- 03 - استفاده از فایلهای تمرین
- 04 - چرا JSON و XML را مستند کنید
- 05 - انواع دادهها و دادههای ساخت یافته
- 06 - ابزارهایی برای نوشتن JSON و XML
- 07 - علامت گذاری
- 08 - چالش Markdown
- 09 - راه حل نشانه گذاری
1. JSON
- 10 - اصول اولیه JSON
- 11 - نمونههای JSON
- 12 - چالش JSON ایجاد کنید
- 13 - راه حل JSON ایجاد کنید
- 14 - مستندسازی پاسخهای JSON یک سطحی
- 15 - مستندسازی پاسخهای JSON تو در تو
- 16 - مستندسازی درخواستهای JSON
- 17 - مستندسازی چالش JSON
- 18 - مستندسازی راه حل JSON
2. XML
- 19 - مبانی XML
- 20 - ویژگیها و مثالهای XML
- 21 - XML پیشرفته
- 22 - چالش XML
- 23 - راه حل XML
- 24 - مستندسازی XML
- 25 - چالش مستندسازی XML
- 26 - راه حل اسناد XML
3. ابزار
- 27 - ابزارهای مستندسازی دادههای ساخت یافته
- 28 - استفاده از دادههای ساخت یافته برای مستندسازی
نتیجه
- 29 - مراحل بعدی