3 KiB
20240122201309 全体的な書き方の方針
#meta
内容
書いてある内容は、できれば10年後も情報に意味があるように注意。たとえば、URLなどをリンクするだけだと、そのサイトが消滅した場合に何もわからなくなってしまう。本の場合も捨てたり、紛失してしまうことがあるかもしれない。引用は最低限、コピペでよいのでテキストで有用と(少なくとも書いた時には)思ったことを明示するようにする。そのノート単体で読めば、内容が理解できるようになっているのが望ましい。
フォルダ構成
完全フラット。階層は作らない。どのようにフォルダで分類しても完全では無いし、フォルダ内のアイテムを移動した場合、画像などのリソースが見つからなくなってしまうことなどがある。という苦労を20年くらいして、もう無理ということになった。私にはフラットにする以上に、スケールできる上、ロバストなものは作れなかった。
ファイル形式
plain textとして人間が読むことができれば、どのような種類でもかまわない。ただのtxtでも、orgでも、markdownでも、adocでもよい。200203時点ではmarkdownが、面倒さと記述のバランスが取れていると思っているのでメインで使用している。
リンク的なものについては、wikilink記法を使用している。つまり [[こういうやつ]]。
色々なソフトがこのリンクをフォルダ全体から探してきてくれて、破綻することはなさそうだと思っているが、将来問題になってしまう可能性は0ではない。ことはちょっと気になっている。
ファイル名の規則
wikilinkを使う都合上、全部のファイルがユニークなファイル名を持っている必要がある。 そのため、ファイル名にはタイムスタンプを先頭に追加する。 YYYYMMDDHHmmss形式。 これは作成したタイミングのタイムスタンプで、中身を変更してもファイル名は変えない。
例: 20240109190207 hogefuga.md
ファイル内容の規則
専用ファイルなど一部を除き、metadata/front matterのような、システム依存の内容は書かない。 tagを #tag 形式で書くことはOK。
それ以外は、上述の各マークアップを使って書く。
画像その他の非テキストのリソースは assets以下にフラットに保存する。
1行目の最初のヘッディングはファイル名と同じにする。 その直下にタグを列挙。
ざっくり、ファイルの内容は以下のようになる。
# 20240122201909 ものすごいことを発見
#yatta #sugoi
## ものすごい
すごいね。
![[画像.png]]
## よかった
よかったね。
画像のテスト