مستند سازی API با readme.io

مشخصات خوب یک شماره واضح است که در مورد بازاریابی تجارت به توسعه دهنده صحبت می شود. غالباً ، وقتی اولین وسیله مورد نظر را مورد بررسی قرار می دهید ، اولین و بیشترین استفاده از آن است. دلیل بیشتر این که هر شرکت نرم افزاری API-اول آن را از ابتدا بدست آورد.

CHASING THE PERFECTION

اخیراً ، ما تصمیم گرفتیم که صفحه اسناد خود را به سطح بعدی برسانیم. ما با جستجوی یک الگوی نقش شروع کردیم. ما از ده ها کدگذار ارشد که روزانه با محصولات API / SaaS کار می کنند سؤال کردیم: بهترین مشخصات شما تا به حال دیده اید؟ برنده خیلی سریع ظاهر شد – Stripe . ما به خصوص دوست داشتیم که چگونه آنها دانش عمومی و مرجع API را به روشی پاک و جداگانه نگه می دارند. ما می خواستیم از این الگوی پیروی کنیم.

در آن زمان ، ما از طرح readme.io در برنامه "توسعه دهنده مرکز" استفاده کرده بودیم. ما به زودی فهمیدیم که برای دستیابی به طراحی جدید باید برنامه را به روز کنیم ، اما حیف است ، زیرا این بسیار گران تمام شد. بنابراین ، پس از انجام حفاری ، این دکمه را پیدا کردیم:

ما آن را امتحان کردیم و بم! ما با یک طرح جدید تقریباً نوار مانند به پایان رسید. یک سایت برای آموزش و نمونه ها و یک صفحه ای کاملاً مناسب برای کوپن مرجع API. بعلاوه ، یک صفحه خوب برای حرکت بین آنها.

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

EVERYDAY README

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

ما همه ویژگی های readme را توصیف نمی کنیم ، اما بگذارید بگویم که با ویرایشگر WYSWIG ، قالب ها ، برجسته سازی نحو ، به عنوان مثال کد ، لینک کاملاً مختصر به صورت خودکار ، و ایموجی ها ، می توانید سایتی سریع را مانند این http://docs.voucherify.io/docs/getting-started در هیچ زمان و زمان دیگری تنظیم نکنید. همچنین می توانید به سرعت توضیحات انتهای عمیق عمیق را با مثالهایی به عنوان مثال جمع کنید. https://docs.voucherify.io/reference#redeem-voucher. اما ، احتمالاً باید خودتان آن را امتحان کنید تا تصویر واقعی را بدست آورید. از حالت ویرایش بصری جداگانه ، باید بپذیریم که پیمایش نرم و صاف است. مهمتر از آن ، یک جستجوی مناسب باعث می شود مانور بین مقالات آسان تر شود.

THE CUSTOMER CONTEXT

سرانجام ، برای یک محصول مبتنی بر فناوری مانند ما ، داشتن بینش نسبت به فعالیت کاربران در صفحه اسناد می تواند بسیار ارزشمند باشد. . Readme نیز به آن اهمیت می دهد. اگرچه آنها ویژگی ردیابی درون برنامه را ارائه نمی دهند ، به شما امکان می دهند Google Analytics ، Segment و Analytics Heap را ادغام کنید.

به همین ترتیب ، ما ادغام Intercom را نیز مفید یافتیم. ما می توانیم درست از یک صفحه آموزشی به سؤالات توسعه دهندگان پاسخ دهیم. و اینترکام به ما نشان می دهد که کدام صفحه را می نگرند ، بنابراین ما فوراً زمینه را می شناسیم.

یک چیز وجود دارد که از دست می دهیم ؛ ما در مورد محصول بیشتر سؤال می کنیم و بعضی از آنها تکرار می شود. ما می خواهیم یک سؤال سریع سریع ایجاد کنیم که به صورت هوشمندانه می تواند یک مقاله مربوطه را پیشنهاد کند. اگر امکان ردیابی مشتری را نیز فراهم کند ، شکایتی نخواهیم کرد. در حالی که ما می دانیم که آنها آن را در نقشه راه دارند ، Intercom به تازگی جایگزین جدی را منتشر کرده است.

GVFM FAMILY

Readme (جنب [ پستچی ) یکی دیگر از ارزش های خوب است. ابزاری که ما با خوشحالی از Voucherify استفاده می کنیم. و ما مطمئن هستیم که وقتی API کوپن ما رشد می کند ، بیشتر از ویژگی های آن استفاده خواهیم کرد ، به عنوان مثال حداقل در نسخه سازی ما همچنین از دیدن نسخه های جدید از گرگوری و تیم کوچک اما فوق العاده تولیدی وی هیجان زده هستیم.

{{CTA}}

بیاموزید که چگونه می توانید با استفاده از پلتفرم مبتنی بر انگیزه ، مشتری و مشتری خود را بهبود ببخشید. ] ‍

محاکمه آزاد را شروع کنید

{{ENDCTA}