KatanA Desktopドキュメント導線
ドキュメント導線
KatanAドキュメント
既存のワークスペースから始めるのが最もスムーズです。
インストール後に最初に何をするかを短く示すページ。
このページでは最初の一歩を案内し、その後リポジトリの詳細なドキュメントへ誘導します。
- 01
Webサイト の ドキュメントの入口
- 02
より深い情報は リポジトリのドキュメント
- 03
閲覧重視 オンボーディング
最初のセッション
フォルダを開き、ドキュメントの読み手として参加する
KatanAは既存のMarkdownワークスペースがある時に最も価値を発揮します。
最初の5分
最初の5分で見ること
- 実際のワークスペースで最初に読む文書を開く。
- 設計仕様ファイルを1つ開く。
- 図を含む文書を1つ開く。
- 目次と分割プレビューの挙動を確認する。
- 更新設定を1回確認する。
SDDとAI
SDD / AI ワークフロー補足
仕様変更をAIエージェントに渡す前に、KatanAで仕様と意図を揃えられます。
3ステップで始める
- HomebrewかDMGでKatanAをインストールする。
- Markdownドキュメントを含むワークスペースフォルダを開く。
- 編集前に、まず読みやすさとダイアグラム表示を確認する。
最初の ワークスペース を開く
ドキュメントを開く前の、初期状態からの導線です。
Blank state
空のワークスペースから始める
ワークスペースが未選択の状態でも、何をすべきか明確なガイドを表示します。
Welcome Screen
ウェルカム画面を確認する
ウェルカム画面(Welcome.md)には、アプリの機能概要やショートカットキーなどの便利な情報がまとまっています。
最初に見ておくとよい設定
ワークスペースを開いた後は、テーマ、レイアウト、およびアップデートの設定を確認しておくと快適に使い始められます。
Theme
ダークテーマのプリセットとライブプレビュー
複数のテーマプリセットとライブプレビュー機能により、アプリ内で見た目を直感的に調整できます。
Layout
目次と分割方向
目次の表示有無や位置、分割方向、ペインの順序などを、プレビューを見ながらレイアウト設定からカスタマイズできます。
Updates
内蔵のアップデート設定
自動アップデートチェックの頻度設定や手動での更新確認を、アプリ内から直接行えます。
Shortcuts
キーボードショートカット設定
ワークフローに合わせてキーボードショートカットを自由にカスタマイズできます。
最初に確認する流れ
- READMEで全体像とセットアップを確認する。
- ADRや仕様書で設計意図を読む。
- リリースノートで最近の変更点を確認する。