2. documentation-platform

Date: 2024-02-19

Status

Accepted

Context

ドキュメント群は Markdown 形式で保存されており、継続的な編集や追加が必要となるため効果的に執筆できる環境を整備することが重要な要素の一つである。 また、ドキュメント群は web で外部公開することで自分のポートフォリオの一部としたい。

Decision

執筆は以下のどちらかのエディタで行う。

• Visual Studio Code
• Obsidian

記述されたドキュメント群は jupyter-book によってビルドされ、 静的ウェブサイトとしてNetlifyでホスティングを行う。

Consequences

Obsidian Sync など synchronization の機能を活用することでラップトップやモバイル機器など様々なデバイスで執筆をすることができる。 また自身でPluginを開発できるためドキュメントの静的解析など執筆を効率化するためのカスタム機能を実装することができる。これは Visual Studio Code も同様である。 一方で Obsidian Sync は有料機能なので金銭面で懸念がある。よりコストがかからない方式があるのであればそちらが望ましい。

ホスティングには自分のポートフォリオサイトでも利用している Netlify を使うため、認知負荷が低く進められる。