この記事は約 4 分で読めます。
筆者プロフィール: ソフトウェアエンジニア。「知った気にならない。いつまでも学び続ける」を信条に、業務と個人開発の両輪で技術を磨いています。AI 駆動開発で複数の個人開発アプリを構築・運用中。
👉 ポートフォリオ: 筆者ホームページ
開発者向けドキュメント (ADR / KDD) をそのままユーザに見せると 困惑させる だけ。本記事では、運用中の SaaS 「たすきば Knowledge Relay」 で採用している ユーザ向け公開 docs 設計 を整理します。
サービスの機能紹介・画面イメージ・コンセプトは公式プロダクトページをご覧ください。
👉 たすきば Knowledge Relay — 公式プロダクトページ
なぜユーザ向けを分離するか
開発者向けドキュメント (ADR / KDD / 設計書) は:
| 特性 | 内容 |
|---|---|
| 専門用語が多い | 技術用語連発 |
| 内部実装の話題 | ユーザに無関係 |
| 公開すると困惑させる | UX 低下 |
たすきばは:
| 配置 | 用途 |
|---|---|
docs/business/, docs/design/
|
開発者向け |
docs/public/ |
ユーザ向け |
物理的に分離。
1. docs/public/ の構成
docs/public/
├── README.md (公開ドキュメント索引)
├── about.md (サービス紹介)
├── account-setup-guide.md (アカウント追加手順)
├── pricing.md (料金詳細)
├── faq.md (よくある質問)
├── help/ (ヘルプセンター、Phase 2)
│ ├── projects.md
│ ├── knowledge.md
│ └── ...
└── legal/ (法的書類)
├── terms-of-service.md
├── privacy-policy.md
└── ...
用途別にディレクトリを切る。
2. about.md の設計
サービス紹介を簡潔に。
# たすきば Knowledge Relay について
## このサービスは
業務プロジェクトの過去資産を、新規プロジェクト立ち上げ時に
**意味検索で自動提案** するサービスです。
## こんな悩みを解決します
- 「あの設計書、どこだっけ?」を消したい
- 過去のリスク対応事例を活かしたい
- 会議中の情報検索コストを削減したい
## 特徴
1. 意味検索: 「セキュリティ要件」⇔「情報漏洩対策」のような表記揺れも拾う
2. ¥0 で始められる: Beginner プランは月額 ¥0、5 席まで
3. コミュニティ: Discord で他ユーザと交流可
## 使い方
[アカウント追加手順](./account-setup-guide.md) を参照。
「何のサービスか」「何を解決するか」「どう始めるか」を 1 ページに。
3. account-setup-guide.md の設計
新規ユーザの登録手順を Step-by-step で。
# アカウント追加手順
## Step 1: アカウント登録
1. https://tasukiba.com/register にアクセス
2. メールアドレスとパスワードを入力
3. 確認メールが届きます
## Step 2: テナント作成
1. ログイン後、テナント名を入力
2. プラン選択 (Beginner / Expert / Pro)
3. 「テナントを作成」をクリック
## Step 3: 初期設定
1. ダッシュボードが表示されます
2. 「新規プロジェクト」をクリックして、最初のプロジェクトを作成
3. 過去資産を取り込みたい場合は、CSV インポート機能を活用
迷わない。
4. 用語の統一
ユーザ向け docs では、業務用語辞書 (GLOSSARY) に従います。
| 用語 (推奨) | NG 表現 |
|---|---|
| プロジェクト | 案件 |
| テナント | ワークスペース |
| ナレッジ | ドキュメント |
統一感のある言葉遣いで、信頼感を高める。
5. スクリーンショットの活用
## プロジェクト作成画面
1. 「プロジェクト名」を入力
2. 「目的」「背景」「対象範囲」を入力
3. 「作成」ボタンをクリック
文章だけでは伝わりにくい操作は、画像で補強。
6. アクセシビリティ配慮
□ 画像には alt テキストを必須
□ 見出しは正しい階層 (h1 → h2 → h3)
□ リンクテキストは具体的に (「こちら」だけにしない)
□ カラーだけに依存しない説明
Web Accessibility 基準を守る。
7. FAQ の設計
## Q: Beginner プランは本当に無料?
A: はい、月額 ¥0、5 席まで完全無料です。
プロジェクト作成・更新の AI 補完は月 50 回まで無料。上限を超えるとその月は
AI 補完のみ一時停止しますが、追加課金はありません (登録操作自体は続けられます)。
もっと使いたい場合は Expert (¥10 / 回) / Pro (¥15 / 回) プランへ。
## Q: 解約はできますか?
A: はい、テナント設定画面からいつでも解約できます。
解約後、データは 30 日間保持されます。
## Q: データのエクスポートは可能ですか?
A: 可能です。ナレッジ / リスク / 課題 / 振り返り は
それぞれ Markdown / CSV でエクスポートできます。
ユーザ目線の素朴な疑問に正直に答える。
8. 法的書類は専門家レビュー
docs/public/legal/ の文書:
□ 利用規約
□ プライバシーポリシー
□ 特定商取引法に基づく表記
これらは 必ず弁護士レビュー。AI で雛形を作ってから、専門家に確認してもらいます。
9. リリース時の公開タイミング
[2026-06-01 リリース時公開]
- about.md
- account-setup-guide.md
- pricing.md
- faq.md
- legal/terms-of-service.md
- legal/privacy-policy.md
- legal/notation-based-on-act.md
リリース 1 週間前までに準備完了。
10. 更新の責任
ユーザ向け docs は、機能追加時に更新が必要。
| 変更内容 | 更新対象 |
|---|---|
| 新機能追加 | about.md / faq.md |
| UI 変更 | スクリーンショット |
| 価格変更 | pricing.md |
PR テンプレートに含めて、機能追加時に必ずチェック。
おわりに
| ファイル | 内容 |
|---|---|
| about.md | サービス紹介 |
| account-setup-guide.md | 登録手順 |
| pricing.md | 料金詳細 |
| faq.md | よくある質問 |
| legal/ | 利用規約 / プライバシーポリシー / 特商法表記 |
ユーザ向け docs を 分離・厳選することで、サービスの第一印象を整える。
これで 「たすきば Knowledge Relay」 連載は完結 です。長きにわたるご閲覧、本当にありがとうございました。
サービスに少しでも興味を持っていただけたら、ぜひ公式プロダクトページもご覧ください。
👉 たすきば Knowledge Relay — 公式プロダクトページ