ドキュメンテーションはテーマにとって重要です。なぜなら、ユーザーがテーマの機能やサポートされていないことを理解する手助けをするからです。同様に、テーマのコードを文書化することで、他のテーマ開発者があなたのテーマをカスタマイズしやすくなります。おそらく、子テーマを使用して。
以下は、あなたのテーマのドキュメンテーションに関する要件と推奨事項のリストです。
- テーマは、必須として、デザインの制限や特別なインストール/セットアップ手順に関するエンドユーザー向けのドキュメンテーションを提供する必要があります。
- テーマは、readme.txtファイルを含めることが必須であり、プラグインディレクトリのreadme.txtマークダウン形式を使用する必要があります。新しいテーマは、2018年10月25日以降、このルールに従う必要があります。古いテーマは、この日から6ヶ月の猶予があります。WordPress 5.8以降、テーマのreadmeファイルは要件の解析が行われません。これは、ヘッダー
Requires PHP
およびRequires at least
がテーマのstyle.css
ファイルから解析されることを意味します。