管理画面:サイドバー 文書ツリー、スペース一覧(/admin/docs)。ページはドキュメントのスペースを作り、管理するためのものです。タイトルを開くと、ディレクトリとページに進みます。
ドキュメントは、操作説明、製品の説明、FAQ に向いています。左が目次、右が記事です。公開のドキュメントには専用の上部バー(ロゴ、サイトへ戻る、ドキュメントを検索)があります。サイトのヘッダーとフッターは使いません。
サイドバーにドキュメントの入口が無いときは、プラットフォームが開放するかを決めています。TimTech に連絡してください。
考え方
| 名前 | 管理画面での呼び方 | 説明 |
|---|---|---|
| スペース | スペース一覧 | 独立した文書庫。例えばサイトの説明と製品説明を、2つのスペースに分けられる |
| フォルダ | ツリー上のフォルダ | サイドバーの章。中にフォルダやページを置ける |
| ページ | ツリー上のページ | 本文そのもの |
| URL スラッグ | 編集欄 | 公開パスを組み立てる断片 |
管理画面の主な入口
| 場所 | 用途 |
|---|---|
スペース一覧(/admin/docs) | スペースを管理する |
| あるスペースを開く | フォルダとページを追加する、ドキュメントを公開する |
| ドキュメント転送 | ドキュメントのリダイレクトを設定する |
| タイプ設定(スペース一覧の右上。権限があるとき) | 公開 URL の接頭辞を変える(例:/docs) |
公開 URL
接頭辞を /docs と仮定します(実際はそのサイトのタイプ設定が正です)。
| 場所 | 例 |
|---|---|
| 既定スペースの概要 | /docs |
| 既定スペース内の記事 | /docs/getting-started/welcome |
| 別スペースの概要 | /docs/product(スペースの slug が product) |
| そのスペース内の記事 | /docs/product/install/step-1 |
既定スペースのコードは通常 default です。公開 URL に default は出ません。
訪問者は ⌘K、または上部の ドキュメントを検索 を使えます。サイトのメニューにドキュメントのリンクを掛けることもできます。メニューを編集する。
サイトのページとの違い
| サイトのページ | ドキュメント | |
|---|---|---|
| 編集 | セクション編集 | ツリーと本文 |
| 見た目 | サイト全体のヘッダーとフッター | ドキュメント専用の上部バーとサイドバーの目次 |
| 向いているもの | 公式サイト、ランディング | 説明、手順、階層のある章 |
誰が操作できるか
既定ではオーナーとサイトの編集者が作成と公開ができます。閲覧者は多くの場合、読むだけです。接頭辞の変更(タイプ設定)は、通常オーナーだけです。
進め方
- スペースが1つあることを確認する(多くのサイトには既定スペースがすでにある)。
- 先にフォルダを章として作り、その中にページを足す。
- フォルダと記事の両方を公開する。 そうしないと公開の目次に出ません。ドキュメントを公開する。
- プライベートウィンドウで正しい URL を開く。slug を変えたあとの古いリンクは ドキュメントのリダイレクトを設定する。
関連する説明
- TimTech へようこそ
- サイトSEOの概要
- AIチャットを設定する(公開済みで、誰でも読めるドキュメントは知識庫に入れる)