💿ドキュメントノートとログノート

2025-02-04

経緯

Obsidianを公開運用する上で、試行錯誤や結論が出ないメモ書きをそのまま公開して良いとは思えない。
しかし、ログを残しておきたいという思いもある。
ノートをどのように書いて、どのように整理するかの「構文ではなく内容面」のルールを決めた方が良い。

内容

[[Obsidianの使い方]]を決めたいとする
ここではこのノートが「ドキュメントノート」と呼ばれる。
ドキュメントノートは書かれる内容やカテゴリを区別するものではない（ルール、レシピ、テンプレートなんでも）

新規で作成する場合

[[Obsidianの使い方]]ノートを作成する
[[Obsidianの使い方]]のメモ・ログセクションに[[2025-02-04 Obsidianの使い方を決める]]リンクを作る
- この[[2025-02-04 Obsidianの使い方を決める]]がログノート（もしくはタスクノート）と呼ばれる
以後の作業はログノート側で実施する
ログノート側の作業が概ね完了したら内容をドキュメントノートに整理する
- この際ログノート側の内容に手を加えても良い（整理済みな場所をDoneにするなど）が、基本的にはそのまま残しておく
ドキュメントノート側のログノートへのリンクはそのまま残しておく

※このノートのように単純なルールの場合は、直接ドキュメントノートから書き始めてもよい

検討ログのリストが深くなるなど複雑な内容になったら、その段階でログノートに分割して再開する
-> 💿深いリスト（目安6以上）を避ける

内容を更新する場合

細かい修正の場合

レベル: パッチアップデート、マイナーアップデート

直接ドキュメントノートを修正する
必要な場合は、メモ・ログセクションにChangelogとして簡単な変更内容を残す
必要な場合は、変更作業用のノートを別途作るのは全く問題ない

大きな修正の場合

レベル: メジャーアップデート

新規と同様、作業用ログノートを作成する
現行のドキュメントノートに日付をつけて過去版にする
- `Obsidianの使い方 yyyy-mm-dd～yyyy-mm-dd
- 導入日がわからない場合は～以降の日付だけで良い
新版ドキュメントノートのメモ・ログセクションに旧版の内容をコピーし、作業用ログノートのリンクを追記する
- ※このセクションを別ノートのEmbedにした方が良い？
作業用ログノートには、新板旧版どちらのリンクも記述する
以降は新規と同様

他ノートとのリンクの様子

ドキュメントノートは、対象ログノート以外は基本的に他ドキュメントノートのみ参照する
ログノートは、対象ドキュメントノートと日付ノートからのみ被参照される

[[📄Obsidianの使い方]] 
	-> [[📄Oタグとリンクの違い]]、[[📄フロントマター一覧]]
	-> [[🧾2025-02-04 Obsidianの使い方を決める]]

[[🧾2025-02-04 Obsidianの使い方を決める]]
	<- [[📄Obsidianの使い方]] 
	<- [[2025-02-04]]
	<- [[2025-02-06]]

ログノートに入らなければ、リンクを辿ってもドキュメントノートだけが露出する形となる ※バックリンク、2hopリンクを除く

影響

メリット

作業履歴を残すことになるので、ドキュメントの経緯などがよりわかりやすくなる
過去版履歴を残すことになるので、更新による影響を調査しやすい
公開する場合、整理されたドキュメントノートが露出して、雑多なログノートは意図的な閲覧になるので、閲覧者が見やすくなる
公開しない場合でも、自分がノートを見返す際に整理された情報だけを見やすくなる

デメリット

ログノートから他ドキュメントノートへのリンクは特に制限しないため、バックリンク汚染はむしろ多くなる可能性がある
- ログノートとドキュメントノートの2倍の被リンク
新規に作る場合は2つのノートの作成、更新する場合はいくつかのタイトル更新やリンク移動が必要になるので作業量が増える
- この運用をしない場合でも整理は結局必要で、整理をしないならノートの価値はないので言い訳にはならなそう

経緯

内容