آموزش هنر مستندسازی API
The Art of API Documentation
شرح دوره
این سومین دوره از سری دوره‌ها برای نویسندگان فنی است که می‌خواهند نحوه نوشتن اسناد API را یاد بگیرند. دو دوره اول "Learn API Technical Writing: JSON and XML for Writers" و "Learn API Technical Writing: REST for Writers" نام دارند و توصیه می شود ابتدا آن دوره ها را بگذرانید، مگر اینکه با مستندات API آشنایی کامل داشته باشید. نحوه مستندسازی مطالب مرجع.
این دوره نحوه نوشتن مستندات مفهومی API مانند مرور کلی، بخش‌های شروع کار و آموزش را آموزش می‌دهد. در بیشتر موارد، هیچ تجربه برنامه نویسی مورد نیاز نیست، اما نویسندگان فنی با تجربه برنامه نویسی همچنان آن را مفید خواهند یافت.
علاوه بر مطالب مفهومی، این دوره دستورالعمل‌هایی را برای کد نمونه خوب، ابزارهایی برای ایجاد درخواست‌های REST، و نحوه یافتن یک پروژه منبع باز برای مستندسازی به عنوان راهی برای ورود به حوزه نوشتن API را پوشش می‌دهد.
API ها چیست؟
API ها (رابط برنامه های کاربردی) نحوه صحبت سیستم های نرم افزاری با یکدیگر را تعریف می کنند و مستندسازی API یک زمینه به سرعت در حال رشد است. نیاز شدیدی به نویسندگانی وجود دارد که بتوانند API ها را درک کنند و آنها را توضیح دهند تا توسعه دهندگان نرم افزار بتوانند نحوه استفاده از آنها را درک کنند. نویسندگان API می‌توانند در موقعیت‌های پردرآمد در لبه فناوری قرار بگیرند.
مواد مفهومی چیست؟
مستندات API از مواد مرجع و مطالب مفهومی تشکیل شده است. مواد مرجع جزئیات API را توصیف می کند: تکه های هر درخواست و پاسخ یا هر کلاس و عضو چیست. مواد مفهومی توسعه دهندگان را به گونه ای هدایت می کند که شروع به کار با یک API جدید برای آنها آسان باشد.
در این دوره آموزشی چیست؟
در پایان دوره، نحوه نوشتن مطالب مفهومی API خوب، نحوه برقراری تماس های REST با استفاده از رابط کاربری گرافیکی و ابزارهای خط فرمان، و نحوه یافتن یک پروژه منبع باز برای مستندسازی را خواهید فهمید. در این دوره آموزشی خواهید یافت:
- 8 ویدیو که:
- نحوه نوشتن مطالب مفهومی خوب را شرح دهید
- دستورالعمل هایی برای کد نمونه خوب ارائه کنید
- نحوه استفاده از ابزارها برای برقراری تماس های REST را نشان می دهد
- شما را از طریق نمونه هایی از نحوه یافتن پروژه های منبع باز در اینترنت راهنمایی می کند
- 2 تمرین عملی برای هدایت شما به درخواست های REST با استفاده از ابزار
- ارائه های پاورپوینت به عنوان منبعی برای هر سخنرانی ویدیویی
- یک PDF با منابعی برای یافتن پروژه های منبع باز
تکمیل دوره تقریباً 1 ساعت و 30 دقیقه طول می‌کشد، بسته به سرعت انجام تمرین‌ها.
معرفی Introduction
-
معرفی Introduction
مواد مفهومی API API Conceptual Material
-
مواد مفهومی Conceptual Material
-
مواد بررسی اجمالی API API Overview Material
-
یادداشتی در مورد بخش شروع به کار A note on the Getting Started Section
-
بخش شروع به کار Getting Started Section
-
آموزش ها Tutorials
-
کد نمونه Sample Code
ابزار Tools
-
ابزارهایی برای فراخوانی API های REST Tools for Calling REST APIs
-
تمرین عملی: مشتری GUI REST (پستچی) Hands-on Exercise: GUI REST client (Postman)
-
تمرین عملی: ابزار خط فرمان (cURL) Hands-on Exercise: Command-line Tool (cURL)
از اینجا به کجا برویم Where to Go From Here
-
یافتن یک پروژه منبع باز برای مستندسازی Finding an Open Source Project to Document
-
مرور Review
-
طرح کلی مستندات API API Documentation Outline
-
سخنرانی جایزه: پیشنهاد برای اولین دوره در سری بعدی Bonus Lecture: Offer for First Course in the Next Series
Udemy (یودمی)
یودمی یکی از بزرگ‌ترین پلتفرم‌های آموزشی آنلاین است که به میلیون‌ها کاربر در سراسر جهان امکان دسترسی به دوره‌های متنوع و کاربردی را فراهم می‌کند. این پلتفرم امکان آموزش در زمینه‌های مختلف از فناوری اطلاعات و برنامه‌نویسی گرفته تا زبان‌های خارجی، مدیریت، و هنر را به کاربران ارائه می‌دهد. با استفاده از یودمی، کاربران می‌توانند به صورت انعطاف‌پذیر و بهینه، مهارت‌های جدیدی را یاد بگیرند و خود را برای بازار کار آماده کنند.
یکی از ویژگی‌های برجسته یودمی، کیفیت بالای دوره‌ها و حضور استادان مجرب و با تجربه در هر حوزه است. این امر به کاربران اعتماد می‌دهد که در حال دریافت آموزش از منابع قابل اعتماد و معتبر هستند و می‌توانند به بهترین شکل ممکن از آموزش‌ها بهره ببرند. به طور خلاصه، یودمی به عنوان یکی از معتبرترین و موثرترین پلتفرم‌های آموزشی آنلاین، به افراد امکان می‌دهد تا به راحتی و با کیفیت، مهارت‌های مورد نیاز خود را ارتقا دهند و به دنبال رشد و پیشرفت شغلی خود باشند.
https://donyad.com/d/30ef51
Peter Gruenbaum
رئیس، پل SDK
نمایش نظرات