実際の会話からまとめた EmDash CMS ユーザードキュメント
繰り返し寄せられるユーザーの質問を長文ドキュメントと FAQ にマッピングした記録と、公開の優先順位・編集上の基準。
このページの目的
このページは、繰り返しのサポート会話を長く価値の残るドキュメント資産に落とし込んだ経緯を記録します。
ドキュメント戦略を内部の想定ではなく、観測されたユーザーの摩擦に結びつけます。
ソースの痛みとドキュメントの置き場所
痛み 1: 「空の EmDash プロジェクトからどう始めればよいか?」
観測されたパターン: コードを書く前にフォルダ計画を求め、最初からアーキテクチャのトレードオフが必要。
置き場所: docs/docs の長文ガイド。順序、根拠、アンチパターンの分析が必要なため。
マッピングしたページ:
docs/docs/emdash-cms-project-bootstrap-and-directory-layout.mdx
痛み 2: 「Cloudflare の Free プランにデプロイできるか。具体的に何が壊れるか?」
観測されたパターン: 機能境界と課金画面の文言の解釈で、部分的にはデプロイできるが失敗する。
置き場所: docs/docs と docs/faq に分割:
- デプロイのランブックは長文ドキュメント
- 課金と境界の明確化は FAQ
マッピングしたページ:
docs/docs/emdash-cms-cloudflare-free-tier-production-playbook.mdxdocs/faq/emdash-cms-cloudflare-pricing-and-billing-faq.mdxdocs/faq/emdash-cms-cloudflare-free-plan-limitations-faq.mdx
痛み 3: 「これらのコマンドはどこで実行すべきか?」
観測されたパターン: コマンド自体は正しくても、作業ディレクトリの文脈が間違っていることが多い。
置き場所: FAQ。短い診断と意思決定ルールが必要なため。
マッピングしたページ:
docs/faq/emdash-cms-deployment-command-context-faq.mdx
痛み 4: 「デプロイが本当に終わったかどうか、どう検証するか?」
観測されたパターン: ルートに届くところで止まり、管理やデータ経路の検証を欠く。
置き場所: チェックリスト形式と短いトリアージ順の FAQ。
マッピングしたページ:
docs/faq/emdash-cms-deployment-verification-and-first-login-faq.mdx
痛み 5: 「Dynamic Workers は実際に何のためか?」
観測されたパターン: 機能名は理解するが、セキュリティ境界の含意は理解しない。
置き場所: docs/docs のアーキテクチャガイド。一行ではなくモデル説明のため。
マッピングしたページ:
docs/docs/emdash-cms-plugin-runtime-and-security-model.mdx
公開順序と根拠
推奨する公開順:
docs/faq/emdash-cms-cloudflare-pricing-and-billing-faq.mdxdocs/docs/emdash-cms-cloudflare-free-tier-production-playbook.mdxdocs/faq/emdash-cms-cloudflare-free-plan-limitations-faq.mdxdocs/docs/emdash-cms-project-bootstrap-and-directory-layout.mdx- 残りのアーキテクチャとセルフホストのリファレンス
順序の原則:
- 混乱が大きく、サポート負荷が高いトピックを先に公開する
- 次に実行手順の完全なガイドを公開する
- 最後に深いアーキテクチャのリファレンスを公開する
ドキュメントの信頼性を保つ編集ルール
今後の追加では次の基準を使います。
- 判断と境界を先に、仕組みはそのあと
- 各操作に成功の目安と失敗の目安を含める
- 影響の大きいステップごとにロールバックまたはフォールバックを用意する
- 測定可能な基準に結びつかない抽象的な形容詞は避ける
- マーケティング調子ではなく、時間に追われる運用者向けに書く
メンテナンスのルーティン
次の三つの入力で、このマッピングを月次で見直します。
- 上位の繰り返しサポート質問
- ユーザー報告からの失敗デプロイパターン
- 離脱が多く完了フィードバックが少ないドキュメントページ
一か月に同じ質問が二回以上出たら、既存ページの診断を改善するか、狙いを絞った FAQ を追加します。