 |
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作成者は、エンドユーザー向けの製品ドキュメントの作成も担当する場合があります。
完全性を確保するためにリファレンスドキュメントが自動生成される場合もありますが、開発者の作業開始を支援するドキュメントは、プロのAPIライターが作成し、各分野の専門家がレビューする必要があります。[ 1 ]これにより、開発者が主要な概念を理解し、すぐに作業を開始できるようになります。
製品
API ライターは次のような内容のドキュメントを作成します。
- APIリファレンスガイド
- プログラマー向けガイド
- 開発者マニュアル
- 管理マニュアル
- インストールガイド
- 実装および統合ガイド
参照
参考文献
- ^ジェイコブソン、ダニエル (2011). API：戦略ガイド. オライリー. p. 101. ISBN 9781449321642。
