Skip to content

Tools Guide (docs/tools.md / docs/tools.project.md 作成ガイド)

本ガイドは、テンプレート共通および各プロジェクト固有の開発ツール・タスク(.mise/ 設定や <root>/tools/ 配下、各種実行基盤)の使用方法やコマンド実行手順を定義する docs/tools.md および docs/tools.project.md を作成・編集する際の記述ルールおよびテンプレートを提供するものです。

概要と目的

開発ツール定義ファイルは、プロジェクトで利用する各種ツール(mise タスク、カスタムスクリプト、コンテナ実行環境等)の役割と具体的なコマンド実行手順をまとめ、AI エージェントおよび開発者が正しい手順でツールを実行できるように定義するためのドキュメントです。

記述ルール

  1. 配置場所とファイル名の区分:
    • docs/tools.md: テンプレート共通の開発ツール(アクション)を記述します(テンプレート同期対象)。
    • docs/tools.project.md: プロジェクト固有の開発ツール(アクション)を記述します(同期対象外)。
  2. ID 形式の付与:
    • docs/tools.md では <AIDEV-TOOL-ID(1)> 形式(例: AIDEV-TOOL-1, AIDEV-TOOL-2)を使用します。
    • docs/tools.project.md では <TOOL-ID(1)> 形式(例: TOOL-1, TOOL-2)を使用します。
  3. 章立てとセクション構成:
    • ツール(アクション)ごとに ## <ID>: <action-name> の見出し(章)を作成し、概要、実行コマンド、処理内容を記述します。
    • 一覧表(サマリーテーブル)は作成せず、各章に直接詳細を記述します。
  4. フロントマターの付与:
    • docs/AGENTS.md に定める標準フロントマター(name, description, timestamp, ai)を付与します。

テンプレート

1. docs/tools.md テンプレート(共通ツール用)

markdown
---
name: tools.md
description: aidev-template 共通開発ツールおよび mise タスクの利用手順と仕様
timestamp: YYYY-MM-DD
ai: ai-coauthored
---

# Tools

本ドキュメントは、本テンプレート共通の開発ツールおよび `.mise/config.toml` に定義された mise タスクの役割、実行コマンド、処理内容をまとめたものです。

各ツール(アクション)には `<AIDEV-TOOL-ID(1)>` 形式の ID(`AIDEV-TOOL-1`, `AIDEV-TOOL-2`, ...)が付与されています。プロジェクト固有のツールについては `docs/tools.project.md`(ID 形式: `<TOOL-ID(1)>`)を参照してください。

## AIDEV-TOOL-1: <action-name>

<ツール・アクションの概要説明>

-   **実行コマンド**:

    ```powershell
    mise run <action-name>
    ```

-   **処理内容**:
    -   <実行される処理の詳細・対象ファイル・副作用等>

2. docs/tools.project.md テンプレート(プロジェクト固有ツール用)

markdown
---
name: tools.project.md
description: 本プロジェクト固有の開発ツールおよび mise タスクの利用手順と仕様
timestamp: YYYY-MM-DD
ai: ai-coauthored
---

# Project Tools

本ドキュメントは、本プロジェクト固有の開発ツールおよびタスクの役割、実行コマンド、処理内容をまとめたものです。

各ツール(アクション)には `<TOOL-ID(1)>` 形式の ID(`TOOL-1`, `TOOL-2`, ...)が付与されています。テンプレート共通のツールについては `docs/tools.md`(ID 形式: `<AIDEV-TOOL-ID(1)>`)を参照してください。

## TOOL-1: <action-name>

<ツール・アクションの概要説明>

-   **実行コマンド**:

    ```powershell
    mise run <action-name>
    ```

-   **処理内容**:
    -   <実行される処理の詳細・対象ファイル・副作用等>