API writer

An API writer is a technical writer who writes documents that describe an application programming interface (API). The primary audience includes programmers, developers, system architects, and system designers.

An API is a library consisting of interfaces, functions, classes, structures, enumerations, etc. for building a software application. It is used by developers to interact with and extend the software. An API for a given programming language or system may consist of system-defined and user-defined constructs. As the number and complexity of these constructs increases, it becomes very tedious for developers to remember all of the functions and the parameters defined. Hence, the API writers play a key role in building software applications.

Due to the technical subject matter, API writers must understand application source code enough to extract the information that API documents require. API writers often use tooling that extracts software documentation placed by programmers in the source code in a structured manner, preserving the relationships between the comments and the programming constructs they document.

API writers must also understand the software product and document the new features or changes as part of the new software release. The schedule of software releases varies from organization to organization. API writers need to understand the software life cycle well and integrate themselves into the systems development life cycle (SDLC).

API writers in the United States generally follow The Chicago Manual of Style for grammar and punctuation.

API writers typically possess a mix of programming and language skills; many API writers have backgrounds in programming or technical writing.

• Computer programming background (Knowledge of C, C++, Java, PHP, or other programming languages)
• Knowledge of formatting standards like Doxygen, Javadoc, OpenAPI, or DITA
• Knowledge of editors and tools, like FrameMaker
• Excellent communication and writing skills to interact with developers
• Knowledge of the cURL utility so that they can work with HTTP-based APIs
• Knowledge of Swagger, an API documentation standard and delivery tool growing increasingly popular with developers

يمكن لكتاب واجهات برمجة التطبيقات (API) ومجموعات تطوير البرامج (SDK) الخبراء أن يصبحوا بسهولة كتاب برامج .

عادةً ما تنقسم عملية كتابة واجهات برمجة التطبيقات (APIs) إلى مراحل تحليل وفهم شفرة المصدر ، والتخطيط، والكتابة، والمراجعة. وفي كثير من الأحيان، لا تسير هذه المراحل الثلاث بشكل خطي تمامًا.

تختلف معايير الكتابة والتقييم بين المؤسسات. تُكتب بعض وثائق واجهة برمجة التطبيقات (API) الأكثر فعالية من قِبل أشخاص لديهم القدرة الكافية على فهم آلية عمل تطبيق معين، بحيث يمكنهم ربط البرنامج بالمستخدمين أو ربط مكوناته المختلفة بالغرض العام للبرنامج. وقد يكون كتّاب واجهة برمجة التطبيقات مسؤولين أيضًا عن كتابة وثائق المنتج للمستخدم النهائي .

مع أن الوثائق المرجعية قد تُنشأ تلقائيًا لضمان اكتمالها، إلا أن الوثائق التي تساعد المطورين على البدء ينبغي أن يكتبها كاتب متخصص في واجهات برمجة التطبيقات (API) وأن يراجعها خبراء في المجال. ^{[ 1 ]} وهذا يضمن فهم المطورين للمفاهيم الأساسية وقدرتهم على البدء بسرعة.

يقوم كتّاب واجهات برمجة التطبيقات (API) بإنتاج وثائق تتضمن ما يلي:

• أدلة مرجعية لواجهة برمجة التطبيقات (API)
• أدلة المبرمجين
• أدلة المطورين
• كتيبات الإدارة
• أدلة التثبيت
• أدلة التنفيذ والتكامل

• الاتصالات التقنية
• أدوات الاتصال التقني
• مقارنة بين مولدات الوثائق