کتاب‌های راهنما برای فناوری: چگونه مستندات را «بهتر» ساختم

سلام توسعه دهندگان زیبا!

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

آن وقت است که یک ایده به ذهنم خطور کرد – آیا می توانم آنها را بهتر کنم؟ خوب، چند گزینه وجود داشت.

توضیحات تصویرتوضیحات تصویر

گزینه های #1 و #2 اساساً غیرممکن بودند، اما گزینه #3 عملی به نظر می رسد. یک راه ایده آل برای کسب درآمد نیست اما بهترین راه برای ایجاد تفاوت

و در اینجا Handbooks for Tech، یک سرویس اسناد معمولی، بسیار بهتر است.

“Handbooks for Tech” چیست؟

این نام تجارت جدید من است! نه، شوخی کردم، این یک تجارت نیست. این بیشتر یک سرویس برای مقداری پول است. (آیا این تعریف کسب و کار است؟ نمی دانم.)

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

توضیحات تصویرتوضیحات تصویر

به طور خلاصه، این چیزی است که ما در Handbooks for Tech انجام می دهیم:

  • ما مستندات محصول را برای محصولات فنی در نظر گرفته شده برای توسعه دهندگان و سایر متخصصان فناوری ارائه می دهیم. از آنها به عنوان “راهنما” یاد می شود، زیرا … کمتر ترسناک به نظر می رسد از …

Source link