آموزش API Technical Writing: JSON و XML for Writers

Learn API Technical Writing: JSON and XML for Writers bestseller

نکته: آخرین آپدیت رو دریافت میکنید حتی اگر این محتوا بروز نباشد.

نمونه ویدیوها: (صرفا برای مشاهده نمونه ویدیو، ممکن هست نیاز به شکن داشته باشید.)

توضیحات دوره: API Documentation 1: به نویسندگان فنی نحوه مستندسازی داده های ساخت یافته را آموزش می دهد. بدون نیاز به تجربه برنامه نویسی خواندن و درک داده های ساخت یافته در فرمت های JSON و XML. برای فایل‌های JSON و XML، برای اسناد API یا انواع دیگر اسناد، اسناد بنویسید. نحوه ویرایش JSON و XML را برای ابزارهایی که اسناد تولید می کنند را بدانید. پیش نیازها: یک ویرایشگر متن (مانند Notepad++ یا Atom) و یک Word Processor (مانند MS Word، Apple Pages یا Google Docs)

این اولین دوره از یک سری دوره ها برای نویسندگان فنی است که می خواهند نحوه نوشتن اسناد API را یاد بگیرند. این دوره آموزش می دهد که چگونه داده های ساختاریافته را با تمرکز بر دو فرمت داده های ساخت یافته بسیار محبوب: JSON و XML مستند کنید. اگر با مستندات API تازه کار هستید، این مکان عالی برای شروع است. هیچ تجربه برنامه نویسی مورد نیاز نیست، اما نویسندگان فنی با تجربه برنامه نویسی که می خواهند درباره داده های ساختاریافته بیشتر بدانند، همچنان مفید خواهند بود.

API ها چیست؟

API ها (رابط برنامه های کاربردی) نحوه صحبت سیستم های نرم افزاری با یکدیگر را تعریف می کنند و مستندسازی API زمینه ای است که به سرعت در حال رشد است. نیاز شدیدی به نویسندگانی وجود دارد که بتوانند API ها را درک کنند و آنها را توضیح دهند تا توسعه دهندگان نرم افزار بتوانند نحوه استفاده از آنها را درک کنند. نویسندگان API می‌توانند در موقعیت‌های پردرآمد در لبه تکنولوژی قرار بگیرند.

در این دوره آموزشی چیست؟

در پایان دوره، متوجه خواهید شد که APIها چیست، چرا مهم هستند و چگونه داده های ساختاریافته را بخوانید و مستند کنید. در این دوره آموزشی خواهید یافت:

هشت ویدیو که:
- اطلاعات پس‌زمینه APIها و داده‌های ساختاریافته را ارائه می‌کنند
- نمونه فایل‌های JSON و XML را تجزیه کنید تا نحوه عملکرد آنها را به شما نشان دهیم
- نمایش مستندات JSON و XML در زمان واقعی و روایت شده
چهار تمرین عملی برای هدایت شما در ساخت و مستندسازی فایل‌های JSON و XML
دو سخنرانی مبتنی بر متن در مورد ابزارهای نرم افزار مفید
پنج آزمون کوتاه که شما را سرحال نگه می دارد
ارائه های پاورپوینت به عنوان منبعی برای هر سخنرانی ویدیویی

بسته به سرعت انجام تمرینات، دوره تقریباً 2.5 ساعت طول می کشد.

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

معرفی Introduction

بررسی اجمالی Overview
انواع داده ها و داده های ساخت یافته Data Types and Structured Data
شناسایی انواع داده ها Identify Types of Data
ابزارهایی برای نوشتن JSON و XML Tools for Writing JSON and XML

JSON JSON

JSON چیست و چگونه کار می کند؟ What is JSON and How Does It Work?
یک تمرین فایل JSON ایجاد کنید Create a JSON File Exercise
آزمون JSON JSON Quiz
مستندسازی JSON Documenting JSON
تمرین مستندسازی JSON JSON Documentation Exercise
اسناد JSON JSON Documentation
جایگزینی برای تورفتگی An Alternative to Indenting

XML XML

XML چیست و چگونه کار می کند؟ What is XML and How Does It Work?
تمرین XML ایجاد کنید Create XML Exercise
امتحان XML XML Quiz
مستندسازی XML Documenting XML
تمرین مستندسازی XML XML Documentation Exercise
اسناد XML XML Documentation

کلمات پایانی Final Words

ابزارهایی برای نوشتن اسناد داده های ساخت یافته Tools for Writing Structured Data Documentation
استفاده از داده های ساخت یافته برای مستندسازی Using Structured Data for Documentation
بررسی و مراحل بعدی Review and Next Steps
سخنرانی جایزه: پیشنهاد برای دوره بعدی مجموعه Bonus Lecture: Offer for Next Course in the Series