文書化のためのワークフローとベストプラクティス
私たちは非常にカスタムで時々変わるテンプレートの束を作成してきましたが、テーマごとに似たような部分の束も持っています。私たちがドキュメントを作成してユーザーに渡す方法を合理化しようと思っていて、彼らがドキュメントを作成するために何を使っているかを見るためにWPAコミュニティを探していました。私は私達が進むにつれて私達が構築するであろうクライアントに伝えるためにウィキのいくつかのタイプを作成することを考えていました、しかしそうする方法に関して私にはまだ完全に明確ではありません。
誰もが彼らの経験、試練、苦難を共有できますか？
前もって感謝します！
JN
素晴らしい質問です。 WordPressサークルには、一般的で包括的なドキュメントワークフローはありません。しかし、いくつかのNiceツールとオプションがあります。
readme.txt
マークダウンベースの機械可読ファイル。その主な目的は公式のプラグインレポジトリによって解析され提示されることですが、それ以外はあまり便利ではありません。
最初の概観には最適で適した場所ですが、高度な説明にはそれほど重要ではありません。
コンテキストヘルプ
管理パネルにおける文脈上の助けがつい最近（比較的）役に立つようになりました。 UIの指示、ローカルおよびリモートのリソースへのリンク、そしておそらく短いFAQのための素晴らしい場所。
ユーザーにとって、情報がないかどうかは新しいことではありません。簡単な回避策は、条件付きで開くようにすることです。たとえば、初回またはユーザーが必要な操作（設定のセットアップなど）を実行するまでです。
PHPDoc
インラインドキュメントは開発者にとって不可欠です。コードの習得や保守が簡単になります。 IDEでとても役に立ちます。
もう少し明白ではない側面は、いくらかの努力でインラインドキュメントをより人間に優しいドキュメントを生成するためのソースとして使用できるということです。典型的な例は相互参照ですが、 wikiページを生成する （恥知らずなプラグイン）のように探求することはあまり一般的でない可能性がたくさんあります。
WP固有ではないツール
WPとPHPが提供するもの以外に、あなたとあなたのクライアントのニーズに応じて、できることは明らかに他にもたくさんあります。
一般的に使用されているWP外のソリューションは、Wiki（またはドキュメントを含むサイト）、issue tracker、ホスト型コミュニティサポートサービスなどです。
また、WP自体に広範なドキュメントを混在させるための探求もありました。最も単純なケースでは、これは単にプラグイン付きの豊富なreadme.htmlを含めることができます。しかし、 ドキュメントのカスタム投稿タイプの使用 のように、もっと複雑な可能性もあります。