プログラマーな日々

プログラマーをやっています。好きなツール:WorkFlowy、好きな言語:C#、好きなサービス:Backlog、好きなAWS:AWS Lambda。

APIドキュメントを書くなら目を通しておくべき2つのガイド

Sandcastleなどのドキュメント生成ツールが普及し、APIリファレンスを作成するのが当たり前になってきましたが、残念ながら質の低いドキュメントも目にすることも少なくありません。

APIリファレンスを改善したい人には、以下を勧めます。

MSDNマガジン

MSDN マガジン: "Hello World!" コーダーのための API ドキュメント執筆ガイド
この記事は、API ドキュメントを執筆する方法についてのガイドです。ここでは、API ドキュメントの最も重要な構成要素について説明し、効果的な API ドキュメントにする方法についていくつか提案します。また、最大限の効果を得るにはどの部分に時間と注意を注ぐべきかということも含め、優れた概要、サンプル コード、およびリファレンスを作成するためのヒントも提供します。 ...

図 2 リファレンス ドキュメントのスタイルが秀逸です。