API ライター

APIライターは、アプリケーション プログラミング インターフェイス(API)を説明するドキュメントを作成するテクニカル ライターです。主な対象読者には、プログラマー、開発者、システム アーキテクト、システム デザイナーが含まれます。

API は、ソフトウェア アプリケーションを構築するためのインターフェイス、関数、クラス、構造体、列挙体などで構成されるライブラリです。開発者はこれを使用してソフトウェアを操作し、ソフトウェアを拡張します。特定のプログラミング言語またはシステムの API は、システム定義の構成要素とユーザー定義の構成要素で構成される場合があります。これらの構成要素の数と複雑さが増すにつれて、開発者が定義されているすべての関数とパラメーターを覚えておくのは非常に面倒になります。したがって、API 作成者はソフトウェアアプリケーションの構築において重要な役割を果たします。

技術的な主題のため、API 作成者は、API ドキュメントに必要な情報を抽出できるほどアプリケーションのソースコードを理解している必要があります。API 作成者は、多くの場合、コメントとドキュメント化されたプログラミング構造との関係を維持しながら、プログラマーがソース コードに配置したソフトウェア ドキュメントを構造化された方法で抽出するツールを使用します。

API 作成者はソフトウェア製品を理解し、新しいソフトウェア リリースの一部として新機能や変更点を文書化する必要もあります。ソフトウェア リリースのスケジュールは組織によって異なります。API 作成者はソフトウェア ライフ サイクルをよく理解し、システム開発ライフ サイクル(SDLC) に統合する必要があります。

米国の API ライターは、文法や句読点に関しては、一般的にシカゴマニュアルスタイルに従います。^[要出典]

API ライターは通常、プログラミングと言語のスキルを組み合わせて持ち、多くの API ライターはプログラミングまたはテクニカル ライティングの経験を持っています。

• コンピュータプログラミングの経験（ C、C++、Java、PHP、またはその他のプログラミング言語の知識）
• Doxygen、Javadoc、OpenAPI、DITAなどのフォーマット標準に関する知識
• FrameMakerなどのエディタやツールに関する知識
• 開発者とやり取りするための優れたコミュニケーション能力と文章作成能力

熟練した API/ソフトウェア開発キット(SDK) 作成者は、簡単にプログラミング作成者になることができます。

API の記述プロセスは通常、ソース コードの分析と理解、計画、記述、およびレビューに分かれています。分析、計画、および記述の各段階が厳密に直線的に進行しないことがよくあります。

作成基準と評価基準は組織によって異なります。最も効果的な API ドキュメントの一部は、特定のアプリケーションの動作を十分に理解し、ソフトウェアをユーザーに関連付けたり、さまざまなコンポーネント構造をプログラムの全体的な目的に関連付けたりできる人によって作成されます。API 作成者は、エンドユーザー向け製品ドキュメントの作成も担当する場合があります。

完全性を確保するためにリファレンスドキュメントが自動生成される場合もありますが、開発者の作業開始に役立つドキュメントは、プロのAPIライターが作成し、専門家がレビューする必要があります。^[1]これにより、開発者が主要な概念を理解し、すぐに作業を開始できるようになります。

API ライターは次のような内容のドキュメントを作成します。

• APIリファレンスガイド
• プログラマー向けガイド
• 開発者マニュアル
• 管理マニュアル
• インストールガイド
• 実装および統合ガイド

• 技術コミュニケーション
• 技術コミュニケーションツール
• ドキュメント生成ツールの比較