By name: work-log description: | 作業内容を記録として残す トリガー: "work-log", "作業ログ", "作業記録" user-invocable: true allowed-tools: Bash(mkdir:*), Bash(date "+%F")
作業ログコマンド
概要
重要な作業や実装内容を.mywork/work-logs/ディレクトリに記録として残すためのコマンド。
たとえばバグ調査であれば「どういう事象か、何が原因だったか、考えられる対策は」みたいな会話をしているはずなのでそれを書く。
使用方法
ユーザーからリクエストがあった場合、以下の形式で現在の会話からログを作成する。
ファイル命名規則
.mywork/work-logs/{下に書いた今日の日付}-{作業タイトル}.md
- 日付: !
date "+%F" - 作業タイトルは英語のケバブケース（例: mongodb-data-import）
- 拡張子は
.md（Markdown形式）
記載項目
ユーザーから要望に合わせて、「単に会話や調査結果をまとめるだけ」なのか「どういう風に作業したのかコマンドなども書くのか」を柔軟に変えてOK
必須項目
- タイトル - 作業や会話の内容を端的に表す見出し
- 概要 - 何をしたのか1-2文で説明
- 目的 - なぜ必要だったのか
推奨項目
作業系であれば、次の項目を書くことを推奨する
- 環境情報 - 作業環境の詳細（OS、バージョン、ツールなど）
- 使用ツール/技術 - 利用したツールやライブラリ
- 注意事項 - 今後同じ作業をする人への注意点
- 作成/変更ファイル - 新規作成・編集したファイルのパス
- 参考資料 - 参照したドキュメントやURL
途中で「AとBどっちがいいか」と迷ったりしたらその旨と最終的な判断結果・理由を記載すること。
記載ルール
セキュリティ
- パスワードや秘密鍵などの機密情報は直接記載しない
- 環境変数名で参照する（例:
<MONGO_INITDB_ROOT_PASSWORDの値>） - APIキーやトークンは必ずマスクする
フォーマット
- Markdown形式で記載
- コードブロックには言語を指定（
bash、javascript など） - テーブルは見やすく整形
- 手順は番号付きリストで記載
言語
- 本文は日本語で記載
- コマンドやコード、ファイル名は英語のまま
- 技術用語は無理に日本語化せず、一般的な表記を使用
テンプレート
# [今日の日付] [日本語作業タイトル]
## 概要
[1-2文で作業内容を説明]
## 目的
- [目的1]
- [目的2]
## 実施手順
## 参考資料
- [ドキュメントやURL]
ユーザーからのリクエスト例：
- 「この会話を残したい」
- 「この作業をドキュメント化して」
- 「作業ログを残して」
- 「後で見返せるように記録して」
- 「手順を文書化して」
これらのリクエストを受けたら、.mywork/work-logs/ディレクトリに適切な命名規則でMarkdownファイルを作成する。
保存場所
すべての作業ログはプロジェクトルートにある以下のディレクトリに保存：
.mywork/work-logs/
このディレクトリが存在しない場合は作成する。