Documentation チュートリアル
ドキュメンテーションの使い方

バージョン

ドキュメントについて

何が文書化できますか？

• さまざまな言語の関数の例。
• 各タグの簡単な紹介。

質問とトピックの違いは何ですか？

• トピックは質問よりも広い範囲を持っています。質問として尋ねられるドキュメンテーションのトピックは、広すぎるため閉じられる可能性があります。
• トピックには複数の例が必要です。 1つの例（例えば、1つのコードブロック）でトピックによってサービスされ得る要求は、おそらくは狭すぎるであろう。

こんにちは世界

こんにちは世界のトピックは、文書化されている言語、フレームワーク、またはシステムのバージョンが最も広い、基本的で完全な実行可能なスタータープログラムで構成されていなければなりません。必要に応じて、備考には例を準備し実行するための基本的な指示が含まれていなければなりません。

このトピックでは、言語の後のバージョンが下位互換性がない場合を除いて、通常、1つまたは2つ以上の例を必要としません。こんにちは世界の話題は、ちょうど言語を学ぶ人の出発点になることを忘れないでください。したがって、学習者が正しいプログラムを達成するために使用できる最小限の作業例を示す必要があります。それは必ずしも言語の最新の機能を示す場所ではありません。