در یک مقاله جدید، بوریس تانه استدلال می‌کند که به جای نوشتن مستندات برای قراردادهای سرویس، بهتر است از انواع (Types) به عنوان قرارداد استفاده شود. این رویکرد به ویژه با ظهور عوامل هوش مصنوعی که به عنوان بزرگترین مصرف‌کنندگان APIها در حال ظهور هستند، اهمیت بیشتری پیدا می‌کند. عوامل هوش مصنوعی نمی‌توانند همیشه با تیم‌های دیگر ارتباط برقرار کنند و به همین دلیل، استفاده از انواع به عنوان رابط کاربری (UX) برای آن‌ها ضروری است.
مشکل اصلی این است که مستندات اغلب به روز نمی‌شوند و با کد اصلی همگام نیستند. این عدم همگام بودن منجر به خطاهای متعدد و اتلاف وقت توسعه‌دهندگان می‌شود. تانه معتقد است که این مشکل به دلیل ماهیت جداگانه کد و مستندات است. هر بار که کد تغییر می‌کند، باید مستندات نیز به روز شوند، اما این کار معمولاً انجام نمی‌شود.
استفاده از انواع به عنوان مستندات اجرایی، مزایای متعددی دارد. توسعه‌دهندگان می‌توانند با مشاهده انواع، درک بهتری از درخواست‌ها و پاسخ‌ها داشته باشند. عوامل هوش مصنوعی نیز می‌توانند از این انواع برای تولید کد معتبر در اولین تلاش استفاده کنند. این رویکرد همچنین ادغام با سرویس‌ها را از طریق نصب بسته‌های SDK (مانند npm install @yourcompany/sdk) آسان‌تر می‌کند.
تانه تاکید می‌کند که هدف از این رویکرد، حذف کامل مستندات نیست. بلکه، استفاده از انواع برای تعریف قرارداد (what) و نگارش توضیحات متنی برای توضیح چرایی (why)، زمان (when) و نحوه (how) استفاده از سیستم است. این رویکرد به عوامل هوش مصنوعی اجازه می‌دهد تا وظایف مربوط به قرارداد را به طور خودکار انجام دهند و توسعه‌دهندگان بر روی جنبه‌های مهم‌تر تمرکز کنند.
در نهایت، تانه پیشنهاد می‌کند که توسعه‌دهندگان به جای نوشتن مستندات جداگانه، از انواع به عنوان مستندات قابل اجرا استفاده کنند. این کار باعث می‌شود که کد و مستندات همیشه با همگام باشند و از بروز خطاها و اتلاف وقت جلوگیری شود. این رویکرد به ویژه در محیط‌هایی که عوامل هوش مصنوعی نقش مهمی در مصرف APIها دارند، ضروری است.
مشاهده مطلب اصلی