プラグインを使ってドキュメントを送信する方法
ワードプレスの公開レポジトリにプラグインを送信するとき、どのようにドキュメントを送信するべきですか？標準的な、または良い慣例とは何ですか？プラグインがミラーリングされているすべてのドキュメントをbeページに含めるだけでいいのでしょうか、それともある種のreadmeも含めるべきですか？ CodeCanyonに送信するときは、プラグインを使用してドキュメントをパッケージ化するのが標準的ですが、有料のソフトウェアなしで表示できるのであれば、どのファイル形式を使用するかはそれほど重要ではありません。私は、しかし、公共のレポに提出するための標準が何であるかを知りません。誰かを洞察しますか？
これは私の最も人気のあるプラグインです。 WordPress用Flowplayer HTML5
私は自分のドキュメントなどを通して考えてみました。すべてのドキュメントはreadme.txtにあるはずです。簡単にアクセスできるようにWordPress.orgに追加されたのと同じ場所です。この リンクを使用して、自分のreadmeを検証 することができます。
すべてのプラグインがドキュメントを必要としているわけではないので、それは必須ではありませんが、ユーザーにとってはより簡単になるでしょう。
それをするもう一つの方法はあなたがドキュメントを持っているreadmeの中にあなたのサイトへのリンクを追加することです。 Polylang はこれを行います。
プラグインのバージョンを変更しなくてもreadme.txtを更新できるので、readmeのドキュメントを更新するのはそれほど難しくありません。そうすれば、それはあなたのサイト上にあります。
これは WordPress.orgのガイドライン でもあります。