API Technical Writer کیست؟
ﺯﻣﺎﻥ ﻣﻄﺎﻟﻌﻪ: 4 دقیقه

API Technical Writer کیست؟

تا به حال اسم API Technical Writer به عنوان یک شغل به گوشتان خورده است؟ خب ترجمه کلمه به کلمه فارسی آن نویسنده تکنیکی API است اما همین اسم نیز کمی گمراه کننده بوده و بیشتر این فکر را در ذهن انسان درست می‌کند که API Technical Writer مسئول همان تولید محتوا است و به نحوی یک دیجیتال مارکتینگ در راه است. اگر چنین فکر می‌کنید باید بگویم که دارید اشتباه فکر کنید چرا که داستان API Technical Writer بسیار متفاوت از آن چیزی است که عناوینی مانند «تولید کننده محتوا» و «دیجیتال مارکتینگ» بتوانند آن را تعریف کنند.

در واقع API Technical Writer نویسنده‌های تخصصی و تکنیکی هستند که در ارتباط با APIهایی که یک اپلیکیشن ارائه می‌دهند توضیحات و مستندات می‌نویسند.

در این مقاله راکت قصد داریم بیشتر در ارتباط با این افراد صحبت کرده و آشنایی بیشتری با آن‌ها پیدا بکنیم.

وظیفه شغلی API Technical Writer چیست؟

وظیفه اصلی API Technical Writer این است که ویژگی‌ها و کاربردهای یک API را برای استفاده عموم و برنامه نویسان دیگر توضیح بدهد. هدف اصلی این است که در ابتدا نشان داده شود که یک API منحصر به فرد چه مشکلی و نیازمندی را برطرف می‌کند و چگونه می‌توان از آن استفاده کرد.

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

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

نوشتن چنین مستنداتی اصلی‌ترین وظیفه یک API Technical Writer خواهد بود. هر مستندی که یک API Technical Writer می‌نویسد باید دارای چهار ویژگی اصلی باشد:

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

تخصص‌های لازم برای یک API Technical Writer بودن

یک API Technical Writer حرفه‌ای که در ایران البته بسیار کم پیدا می‌شود شبیه به یک تولید کننده محتوا و یا یک نویسنده که دنبال فروش یک محصول یا بهینه سازی صفحات اینترنتی است، نیست. در واقع API Technical Writer با داشتن تجربیات و دانش کافی در زمینه برنامه‌نویسی و ساختار توسعه APIها در کنار داشتن توانایی‌های لازم برای نویسندگی، فرایند توسعه و ساخت مستندات را شروع می‌کند.

بیشتر افرادی که API Technical Writer هستند عمدتا افرادی بوده که به عنوان برنامه نویس سابقا تجربه کاری داشته و حال قصد دارند فیلد شغلی خود را تغییر دهند. البته این نکته بسیار مهمی‌ست که هر برنامه نویسی نمی‌تواند یک API Technical Writer باشد چرا که باید با تکنیک‌های نویسندگی، شناخت مخاطب، اصول نگارش و... آشنا باشد.

بنابراین می‌توان تخصص‌های لازم در این زمینه را به صورت زیر در نظر گرفت:

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

چرا داشتن مستندات الزامی است؟

اما یک استارتاپ یا یک شرکت چرا باید یک API Technical Writer را استخدام بکند؟ دلیل اصلی آن داشتن مستندات خوب و مناسب برای اپلیکیشن یا محصولی‌ست که توسعه داده‌اند. زمانی که شما یک محصولی را برای اولین بار ایجاد می‌کنید، اولین نقطه‌ای که هر برنامه نویسی برای یادگیری چگونگی استفاده از آن سراغ‌ش می‌رود قسمت مستندات یا همان Docs است. در صورتی که شما چنین قسمتی را در وبسایت خود نداشته باشید نخواهید توانست به درستی کارکرد محصول‌تان را نشان بدهید.

چه امتیازی برای این مقاله میدهید؟

خیلی بد
بد
متوسط
خوب
عالی
4.67 از 3 رای

3 هفته پیش
api
Technical
Writer
/@arastoo
ارسطو عباسی
برنامه‌نویس و توسعه‌دهنده نرم‌افزار - نویسنده و کپی‌رایتر - #پایتون - #جنگو - #لینوکس

برنامه‌نویس تمام وقت پایتون و مدیر بخش تولید محتوا وبسایت راکت - وبلاگ شخصی: https://arastoo.dev

دیدگاه و پرسش

برای ارسال دیدگاه لازم است وارد شده یا ثبت‌نام کنید

ورود یا ثبت‌نام

در حال دریافت نظرات از سرور، لطفا منتظر بمانید

در حال دریافت نظرات از سرور، لطفا منتظر بمانید

ارسطو عباسی

برنامه‌نویس و توسعه‌دهنده نرم‌افزار - نویسنده و کپی‌رایتر - #پایتون - #جنگو - #لینوکس