کانال تلگرام پشتیبانی تلگرام شماره تماس پشتیبانی: 0930 395 3766
ورود ثبت نام

آموزش نوشتن فنی: نحوه نوشتن اسناد نرم افزار API

Technical Writing: How to Write API Software Documentation

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

چه چیزی را یاد می گیرید

  • API چیست؟
  • اسناد API چیست؟
  • کدام مراحل را دنبال می کند تا مستندات API را ایجاد کند؟
  • کدام ابزار برای استفاده با API

آیا شما یک نویسنده فنی هستید که نیاز به نوشتن اسناد نرم افزار API دارد؟ آیا شما تعجب می کنید که چه چیزی باید آماده شوید و تحویل دهید تا مستندات API با کیفیت بالا داشته باشید و نمی دانید کجا شروع کنید؟

اگر بله، این دوره برای شماست!

API مخفف رابط برنامه نویسی برنامه است. یک رابط یک انتزاع نرم افزاری است که به دو برنامه کاربردی نرم افزار اجازه می دهد تا با یکدیگر ارتباط برقرار کنند.

دو نقش وجود دارد که باید هنگام نوشتن مستندات در مورد یک API بنویسید:

  1. نقش توسعه دهنده که API را ایجاد کرد. این توسعه دهنده نیاز به ارائه اطلاعات در مورد راه API قرار داده است؛ چه درخواست هایی می تواند دریافت کند و چه پاسخی ارائه می دهد.

  2. نقش توسعه دهنده که از API استفاده می کند. این توسعه دهنده باید از طریق اسناد API بخواند تا درک کند که راه هایی برای اتصال به API چیست، چه درخواست هایی را که می تواند به API ارسال کند، و پاسخ هایی که API برای این درخواست ها بازپرداخت می کند، چه هستند.

در این دوره، شما یاد خواهید گرفت:

  • مستندات API و API چیست - توضیح داده شده به طوری که شما می توانید درک کنید. هیچ دانش برنامه نویسی خاصی لازم نیست!

  • کدام مراحل مورد نیاز برای پیگیری برای آماده سازی و ارائه مستندات در مورد API خود - یک چارچوب کوچک برای اطمینان از انجام مراحل برای پیگیری در هنگام تهیه اسناد API.

  • نکات مربوط به 2 ابزار محبوب شما می توانید برای تست API استفاده کنید و مستندات API را به صورت خودکار تولید کنید. به نفع صرفه جویی در وقت شما، ما فقط یک مرور کلی از ابزارهایی مانند Postman و Swagger ارائه می دهیم، اما ما در مورد استفاده از این ابزارها جزئیات بیشتری نداریم - آنها در حال حاضر به خوبی مستند شده اند و دوره های زیادی در مورد استفاده از این ابزارها وجود دارد.

آن را امتحان کنید و ببینید که چگونه می توانید مستندات API را بنویسید، هنگامی که می دانید کدام مراحل اولیه برای پیگیری است!

چه کسی این دوره است:

  • نویسندگان فنی
  • توسعه دهندگان اطلاعات
  • توسعه دهندگان نرم افزار
سرفصل ها و درس ها

معرفی Introduction

  • معرفی Introduction

  • یک API چیست؟ What is an API

  • مزایای استفاده از API Benefits from Using an API

  • چگونه یک API کار می کند How Does an API Work

  • چه کسی مستندات API و API را ایجاد می کند Who Creates API and API Documentation

چارچوب مستند سازی API API Documentation Framework

  • اسناد API چیست؟ What is an API Documentation

  • انواع API ها Types of APIs

  • چه کسی مستندات API را می خواند Who Reads API Documentation

  • اسناد API - نمونه ها API Documentation - Examples

  • اسناد API - چارچوب نوشتن API Documentation - a Framework for Writing

  • اسناد API - ساختار API Documentation - Structure

  • مرحله 1 - دسترسی به API Step 1 - Accessing the API

  • مرحله 2 - پاسخ های API Step 2 - API Responses

  • مرحله 3 - درخواست ها Step 3 - Requests

ابزار توسعه دهندگان مستندات API Tools for API Documentation Developers

  • پستچی - یک ابزار برای استفاده از APIs Postman - a Tool for Using APIs

  • 16 16

بخش پاداش Bonus Section

  • 17 17

نمایش نظرات

نظری ارسال نشده است.

آموزش نوشتن فنی: نحوه نوشتن اسناد نرم افزار API
خرید اشتراک و دانلود خرید تکی و دانلود | 160,000 تومان (5 روز مهلت دانلود) زمان تقریبی آماده سازی لینک دانلود این دوره آموزشی حدود 5 تا 24 ساعت می باشد.
جزییات دوره
1h 24m
17
Udemy (یودمی) udemy-small
10 تیر 1400 (آخرین آپدیت رو دریافت می‌کنید، حتی اگر این تاریخ بروز نباشد.)
8,430
از 5
ندارد
ندارد
ندارد

https://donyad.com/d/b1ff

Google Chrome Browser

Internet Download Manager

Pot Player

Winrar

JPDocu School of Technical Writing JPDocu School of Technical Writing

ما مستندات و DITA نرم افزار را آموزش می دهیم! بیش از 8000 دانشجو! یادگیری نوشتن فنی آسان است - پس از همه ، این فقط سند ساده است! JPDocu School of Technical Writing یک شرکت آموزشی است که علاقه زیادی به کمک کاربر ، ارتباطات فنی و تبدیل آن به یک تجربه کاربری مثبت دارد. دوره های آموزش الکترونیکی ما با ارائه تجارب عملی ساده برای پیگیری و عملی با نوشتن فنی ، به ما در شکل گیری نسل بعدی نویسندگان فنی و توسعه دهندگان اطلاعات کمک می کنیم. ماموریت ما امروزه همه در مورد حرفه های آینده صحبت می کنند. مردم می ترسند که برای نیازهای آینده کار آماده نیستند. ما معتقدیم که نباید از تغییر ترس داشت. ما معتقدیم که با آموزش مناسب ، آموزش و تجربه عملی ، مشتریان ما آماده دیدار با آینده با خوشحالی خواهند بود. بهترین راه برای موافقت با این ترس مطالعه و یادگیری است.

Udemy (یودمی)

یودمی یکی از بزرگ‌ترین پلتفرم‌های آموزشی آنلاین است که به میلیون‌ها کاربر در سراسر جهان امکان دسترسی به دوره‌های متنوع و کاربردی را فراهم می‌کند. این پلتفرم امکان آموزش در زمینه‌های مختلف از فناوری اطلاعات و برنامه‌نویسی گرفته تا زبان‌های خارجی، مدیریت، و هنر را به کاربران ارائه می‌دهد. با استفاده از یودمی، کاربران می‌توانند به صورت انعطاف‌پذیر و بهینه، مهارت‌های جدیدی را یاد بگیرند و خود را برای بازار کار آماده کنند.

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