ソフトウェアのドキュメント
「ソフトウェアのドキュメント」の英語
「ソフトウェアのドキュメント」は英語で software documentation と言います。機能、操作手順、設計情報などをまとめた文書全般を指します。内容を限定するなら user guide や API reference などを使います。
「ソフトウェアのドキュメント」の英語の使い分け
機能説明、操作手順、設計情報などを広く含む文書全般に使います。
user guide
利用者向けの操作方法や基本機能を説明する文書に使います。
API reference
開発者向けにAPIの仕様や使い方をまとめた資料を指します。
The API reference includes examples for authenticating requests.
APIリファレンスには、リクエストを認証する例が載っています。
release notes
新しいバージョンの変更点や修正内容を知らせる文書です。
コアイメージ
ソフトウェアのドキュメントはソフトウェアについての仕様・手順・説明をまとめた文書群
英英
Written materials that describe a software's specifications, usage, procedures, and related explanations for users and maintainers.
語源
software documentationは、software(ソフトウェア)とdocumentation(記録・説明を書く行為やその成果)の合成語で、ソフトウェアに関する説明や記録を指す言葉として成立した。
コラム
- software documentationは製品の機能説明や操作手順、設計情報などを広く含む文書群を指し、対象や目的に応じて内容や形式が変わる
「ソフトウェアのドキュメント」のレベル別の例文
「ソフトウェアのドキュメント」を英語にするときのよくある間違い
× software documentations
documentationは通常、数えない名詞として使います。