دانلود پایان نامه بهبود دسترسی به مستندات API برای کاربران غیرفنی

1. مقدمه 2. روش 3. پیشینه نظری 4. پروژه تحقیقاتی – پیاده سازی 5. نتایج 6. تجزیه و تحلیل 7. بحث و بررسی 8. نتیجه گیری

چکیده – مستندات نرم افزارها، یکی از مهمترین جنبه های فرآیند توسعه نرم افزار است، زیرا انتقال دانش بین افراد را صرفنظر از پیشینه و دانش فنی شان، ممکن می سازد. بخصوص اینکه، رابط های برنامه نویسی برنامه کاربردی (API ها)، ساختاری پایه برای ارتباطات و یکپارچه سازی بین سیستم های نرم افزاری مختلف، فراهم می کنند. بنابراین، ارائه مستندات API منسجم برای فرآیند توسعه نرم افزار بسیار مهم است، زیرا یکی از ابزارهای یادگیری اصلی برای توسعه دهندگانی است که تلاش می کنند تا فناوریهای جدید را یاد بگیرند. درحالی که محققان اصول و مبانی طراحی خوب مستندات API را به مدت بیش از بیست سال مورد مطالعه قرار داده اند، اما اکثر مطالعات تنها بر دیدگاه توسعه دهندگان تمرکز کرده اند. با این حال، با افزایش تعداد شرکت هایی که محصولات «نرم افزار به عنوان سرویس» ارائه می دهند، تولید مستنداتی که برای افراد دارای دانش فنی محدود، یعنی نمایندگان مشتری، قابل دسترس باشد، نیز مهم می شود. برای رفع این خلاء پژوهشی، یک مطالعه موردی در همکاری با یک شرکت نرم افزاری انجام شد. با استفاده از یک رویکرد علم طراحی، این پروژه بر ایجاد یک محیط ارزیابی API تمرکز کرد که در آن کاربران می توانند با انواع API های ارائه شده توسط این شرکت، تعامل داشته باشند. نتایج از طریق یک پرسشنامه برای بازخورد کاربر و با یک مصاحبه انجام شده با توسعه دهندگان این شرکت، ارزیابی شدند. درحالی که پیامد ارزیابی مثبت بود، اما حیطه محدود پروژه، از بررسی جامع تعدادی از جنبه های مهم مستندات API مانند گشت و گذار جلوگیری کرد، بنابراین پژوهش های گسترده تری در آینده لازم است.

Software documentation is one of the most important aspects of the software development process, as it allows the transfer of knowledge between individuals, regardless of their background and their technical knowledge. In particular, Application Programming Interfaces provide the basic structure for the communication and integration between different software systems. Therefore, providing solid API documentation is fundamental for the software development process as it represents one of the main learning tools for developers trying to learn new technologies. While researchers have studied the fundamentals of good API documentation design for over twenty years, most studies only focused on the point of view of developers. However, with the rising amount of companies offering Software-asa- Service products, it has also become important to produce documentation that is accessible to people with limited technical knowledge, i.e. customer representatives. In order to fill this research gap, a case study was conducted in collaboration with a software company. By using a design science approach, this project focused on creating an API playground environment where users could interact with various APIs offered by the company. The results were evaluated through a questionnaire for user feedback and with an interview conducted with developers from the company. While the outcome of the evaluation was positive, the limited scope of the project prevented some important aspects of API documentation such as navigation from being thoroughly examined, therefore more extensive research is needed in the future.