この記事はソニックガーデン プログラマ アドベントカレンダーの6日目の記事です。
はじめに
こんにちは。株式会社ソニックガーデンのmaedanaです。
今回は(自分の知る限り)マイナーなTodo管理用のテキストファイル(todo.txt)及び、このテキストファイルを利用するためのクライアントツールについて書きます。なお今回の話の前提として個人のTodo管理を想定しており、チームのTodo管理は想定していません。
todo.txtは、todo管理のためのテキストファイルのフォーマットの仕様が書かれたドキュメントです。さて、いきなりですがtodo.txt には冒頭で以下のように書かれています。
The first and most important rule of todo.txt:
A single line in your todo.txt text file represents a single task.
つまり、1行1タスクです。例えば以下のようなシンプルな中身のテキストファイルです。
最初にやること
次にやること
基本的にはこれだけです。
なぜテキストファイルなのか
todo.txtをもう少し読み進めると以下のように書かれています。
Plain text is software and operating system agnostic. It's searchable, portable, lightweight, and easily manipulated.
(ただのテキストファイルなので)OS依存しない/検索可能/ポータブル/軽量/操作しやすいという当たり前だけど、とても重要なことが書かれています。個人的嗜好としても
- マウス操作よりキーボード操作が好き
- GUIよりCUI/TUIが好き
- シンプルなものが好き
- 普段使うエディタはNeoVim
ということがあるので、単なるテキストファイルというのはとても相性がいいのです。この単なるテキストファイルをクラウドに自動同期されるようにし、様々なクライアントツールを利用すればPC/スマホなど様々なデバイスで利用することも簡単です。
todo.txtの細かな形式について
todo.txtにとても詳しく書かれていますが、全ては以下の画像に集約されます。
見る人が見ればわかりますが、これはGTD(Getting Things Done)に沿った運用ができる、ということです。今回はGTDについては説明しませんので、気になる方は調べてみるといいと思います。検索すれば日本語の情報や書籍等も豊富に見つかります。なお、拡張仕様を定義することも可能なので、自分好みに拡張することもできます。
todo.txtのクライアントツール紹介
- todo.txt-cli
- https://github.com/todotxt/todo.txt-cli
- todotxtでホスティングしているので公式?のCUIクライント。これで満足できるならきっとこれが一番いいのだと思います。僕の場合は複数プロジェクトを俯瞰してみたいというのがあってこれだけでは流石に運用が難しかったです。
- topydo
- https://github.com/topydo/topydo
- 当初愛用していたツールです。CUI(というか正確にはTUI?)でここまで表現できるのかという驚きがありました。ただ、僕の場合結構大きめの粒度のタスク登録をして、その詳細は別のテキストファイルに書きたい、というのがあってその点で後述の自作ツール作成に繋がりました。
- 完全に余談ですけど、TUIで何か自作するなら例えばRustの https://github.com/ratatui/ratatui など使うと色々出来て楽しいんじゃないかなと思います。
- tokaido
- https://github.com/maedana/tokaido
- 自作のビューワーです。当初TUIで作りたかったんですけど、なかなか思うようにいかず、日頃から慣れているRailsでローカルで動かす前提のWebアプリとして実装しました。NeoVimと連動させないとほぼ意味がないので、その場合はtopydoがいいかなと思います。各Todoの詳細を別テキストファイルで管理したくて作りましたが、自分さえ使えればいいと思っているのであまりちゃんと作り込んでないです。そろそろ作り直したい気持ちはちょっとあります。
- 詳しく言及しませんが、https://github.com/neovim/neovim-ruby を使うことでRubyからNeoVim操作できるので工夫すればもっと色々できそうです。
個人的な運用方法について
- tokaidoをビューワーとして利用
- todo.txtの編集はNeoVim
- tokaidoとNeoVimの連動で個別Todoの詳細をさらに別のテキストファイルで編集
- todo.txtと個別TodoのテキストファイルをGitリポジトリで管理
- Priorityは使わない。エディタで行単位の並び替えをするだけで十分
- Contextは使わない。主に仕事のみでの利用なので切り替える必要性を感じない。
- Projectは凄く使う。複数プロジェクト掛け持ちなのでプロジェクトごとの進行中のタスクを管理したいので。
- 期限付きタスクはdue: をセット(しつつ、リマインド目的で必要に応じて別のリマインダーツールに登録)
このように運用することで
- 移動中など最悪ネット環境がなくてもタスク管理できる
- すべてテキストなのでタスクの詳細テキスト含めてripgrep等で素早く探せる
- タスクの詳細テキストをMarkdownで書くようにしているので、例えばチームへの共有用にgithub issueに内容を転記したいなどの場合でもコピペで済む
など日々の仕事の進める上でとても便利です。
まとめ
Todo管理用のテキストファイル(todo.txt)について紹介しました。自作にこだわりはないので、もっとこれが流行ってもっと使い勝手のよいクライアントができてほしいなーと思ってます。
ソニックガーデン プログラマ アドベントカレンダー 7日目は @LuckOfWise です。お楽しみに！