Skip to main content

作業ログ

About 2 min

作業ログ

ノートより。

今vcpkgのqt5-webengineのビルドができないか、と色々と試行錯誤していて、そのメモがうまく残せていないなぁ、と思っての考え。

作業ログを残すにはどういう形式が良いのだろうか？

現状は大きなテキストファイル

現状は日々の作業記録を書いておくテキストファイルがあって、これに色々書いている。 大体はその日の日付とやった事を箇条書きで書くだけだが、たまにフリーフォーマットで実行したコマンドやその結果などが貼られていたりする。 週単位で区切っていて、さらに月単位で簡単にまとめている。

大きなテキストファイルの利点、残しやすい

大きなテキストファイルに単に書いていく場合、どこに書いたらいいかわからない、とか悩む事はあまり無い。 とりあえず書いておける。 残しておかないものは残らないので、書きやすいのは大きなメリットだ。

大きなファイルの欠点、みづらい

書きやすいメリットと裏表な部分もあるが、書きやすいけれど見づらい。

大きなファイルの欠点、探しづらい

今やってるのは以前にも途中までやった作業のはずだが、結構探しづらくて困っている。 適当に検索をしているが、意外とそのワードがたまたま入っていなかったりする。

大きなファイルの欠点、邪魔になるので書くのに躊躇する

書いたものが結構スペースをとってしまって他の項目が見えなくなるので、あんまり長いログとかは貼りたくない、という気持ちが働く。 そうした書くのを躊躇する要因が嫌だ。

Wikiに1 WikiNameとして書く

アプリ開発などでは、大体そのアプリのWikiNameを作ってそこに作業ログを書いている。パオ碁とか。

Wikiの利点、他への邪魔にならない

大きな1テキストファイルと異なり、WikiはそのWikiNameの外には迷惑をかけないので長いログとか貼るのもそんなに気にならない。

Wikiの欠点、長くなってくるとイマイチ

長くなってくると書く場所まで移動するのも面倒だし、見るのもイマイチ。

Wikiの欠点、作業のカテゴリが曖昧だとどこに書くか悩む

qt5-webviewの評価をしていたら、途中からqt5-webengineを試す方がいい気がしてきてqt5-webengineの記録に繋げたい、 みたいな時に微妙。 タイトルを決めるというのは作業ログと相性が悪い部分はあるよなぁ。

GitHub issue

作業ログで割と使うものにGitHubのissueがあって、これはかなり良い気がしている。

issueの良い所、他の邪魔にならない

長いテキストファイルと違ってこのissueの外には影響が無いので長いログとか貼ってもへっちゃら。

issueの良い所、見やすい

見た目的にも日付ごとに区切られて、mdでフォーマットもされて、後から見やすい。

issueの良い所、探しやすい

issueは割と探しやすい。時期で眺めても見つけられるしタイトルでもそれなりに探せるし検索でも見つけられる。 この辺は単なるテキストファイルよりも少し支援がある（本文がヒットした時にそのissueのタイトルがすぐにわかる、など）。

issueの良い所、長くなってきても入力は楽

別に長くなっても入力にそんなには困らない。これはWikiより良い所。

issueの悪い所、issueを建てるのがかったるい

作業を開始する時にissueを立てるのがかったるい。だから立てるのをサボる事もあり、サボったものはどこにも残らないのでこの世から消え去る。

issueの悪い所、ローカルじゃない

仕事によってはGitHubでは無い時もある。そして仕事じゃない趣味とかだと、ログに名前とかがパスとして残るのを後悔するのはちょっと嫌だ、という事もある。まぁkarino2とかなのでこのURLと何が違うんだ、という話はあるが。

なんとなく思う事を書き出す

GitHub issueはかなり有能。これに近い何かを求めている気がする。

タイトルはおそらく必要であり、これがGitHub issueの見やすさに貢献している。一方でタイトルはあとから割と変更するのでファイル名にはしたくないか。 タイトルを考えるのがかったるい事はある。

howm的にMDDeckにハッシュタグがあればいいのではないか？ただ同じ作業をしている時にいちいち全部にハッシュタグを入れたくは無い気もする。

他の事をしている時に目に入らない、というのは結構重要に思う。これがあるからissueには長いログとかを気にせずに貼れる。大きいテキストファイルには貼れない。

大きなテキストファイルのメリットであるVSCodeで書ける、というのは結構大切な気もする。

なんか特定の作業について書いていくテキストファイルがあって、それがいい感じにタイトル一覧とか検索とかと統合されていればいいかもしれない。 ならば必要なのは日付のファイル名のmdと、先頭のフォーマットが固定されていてスクリプトで整形出来る事か？

必要なもの

  • 日付のmdを置く場所
  • mdの先頭のフォーマットの決定
  • タイトル一覧を日付とともにみる方法
  • grep結果をタイトルと見る方法

とりあえずツールなんてなくてもこれをやってみる事は出来るな。やってみよう。

ディレクトリの名前はslogとする。blogに対抗してSagyouLogという事でslog。えすろぐと読む。

ファイル名は2025_1212_211312.md とかにする。以下のスクリプトで作る。

#!/usr/bin/env bash

BASENAME=`date "+%Y_%m%d_%H%M%S"`


DEST=$(dirname $0)
FILENAME="$DEST/${BASENAME}.md"
echo $FILENAME
echo "# " > $FILENAME

フォーマットは先頭の行だけ # タイトル で始める。 けれど中はマークダウンにはこだわらない。単なるテキストファイルを貼ったりも気にせずやっていく。