ドキュメンテーション

すべてのアプリケーションは、ユーザがアプリケーションを理解し、問題解決を手助けするためのドキュメントを提供するべきです。うまくデザインされたアプリケーションでは使用する前にドキュメントを読む必要がないとしても、ドキュメントはユーザにとって、とくに複雑なアプリケーションの場合は重要なツールなのです。

GNOMEはユーザにドキュメントを提供するための統一されたフレームワークを提供します。それにより業界標準であるDocBook形式のドキュメントをユーザに提供することができます。DocBook形式を使用することは、あなたが書式の詳細に悩む必要がないことを意味します。その代わりに、あなたのドキュメントは他のシステムドキュメントと一貫性のある規則で自動的にフォーマットされます。

GNOMEのヘルプ・ビューアである Yelp により、ドキュメントの表示・印刷、システムのすべてのドキュメントの一覧とすべてのドキュメントにたいするテキストの検索が可能になります。GNOMEのヘルプシステムにより、あなたはこれらの機能を無料で手にすることができます。

アプリケーションのドキュメントの記述についての詳細は GNOME Handbook of Writing Software DocumentationDocBook: The Definitive GuideGNOME Documentation Style Guide を参照してください。