Skip to content

mikuscore の説明を変換ツール中心に整理し、README・開発文書・UI文言を整合させる#170

Merged
igapyon merged 1 commit intodevelfrom
tiga0415hdj
Apr 14, 2026
Merged

mikuscore の説明を変換ツール中心に整理し、README・開発文書・UI文言を整合させる#170
igapyon merged 1 commit intodevelfrom
tiga0415hdj

Conversation

@igapyon
Copy link
Copy Markdown
Owner

@igapyon igapyon commented Apr 14, 2026

概要

mikuscore の説明を、開発者寄り・軽量エディタ寄りの見え方から、「MusicXML-first な譜面変換ツール」という位置づけに揃える変更です。 このコミットでは、README.md を利用者向けに再構成し、開発向け情報を docs/DEVELOPMENT.md に分離しています。あわせて、関連ドキュメントと About mikuscore の UI 文言も同じ方向に更新されています。

変更内容

1. README.md の再構成

README.md は、利用者向けの製品説明に寄せて大きく整理されています。

差分上で確認できる主な内容:

  • mikuscore を MusicXML-first の score converter として説明
  • What mikuscore is for
  • What mikuscore is not
  • Core idea
  • Supported formats
  • Typical use cases
  • Related projects
  • Quick start
  • Documents
  • 日本語セクションの再整理

2. 開発者向け情報の新設

新規ファイル docs/DEVELOPMENT.md が追加されています。

この文書には、差分上で以下の内容が含まれます。

  • build / test / verification コマンド一覧
  • CLI の開発者向けメモ
  • documentation map
  • AI interaction policy への導線
  • debugging note
  • mikuscore-skills および miku-abc-playermikuscore を upstream dependency として取り込むことに関する注意

3. 周辺ドキュメントの位置づけ調整

以下の文書も、README と同じプロダクト像に合わせて更新されています。

  • docs/PRODUCT_POSITIONING.md
  • docs/FORMAT_COVERAGE.md
  • docs/CONVERSION_PRINCIPLES.md
  • docs/AI_INTERACTION_POLICY.md

差分上で確認できる方向性:

  • mikuscore は notation editor ではなく変換ツールであることを明確化
  • MusicXML-first / conversion / inspection / handoff の役割を強調
  • AI は bridge use case の一つであり、製品の唯一の主軸ではないことを明示
  • format coverage でも、lossless editing parity を約束するものではないことを補強

4. About mikuscore UI 文言の更新

mikuscore-src.html と生成物 mikuscore.html にある About mikuscore の tooltip 文言が更新されています。 また、docs/spec/SCREEN_SPEC.md の該当説明も同じ内容に合わせて更新されています。

差分上で確認できる変更例:

  • browser-based local score editor から browser-based MusicXML-first score converter へ変更
  • workflow を Inspect the score and diagnostics / Export or hand off in another format に寄せて更新
  • MuseScore などの dedicated notation editor を使うべき場面を notation editing として明示

変更ファイル

  • README.md
  • docs/DEVELOPMENT.md
  • docs/PRODUCT_POSITIONING.md
  • docs/FORMAT_COVERAGE.md
  • docs/CONVERSION_PRINCIPLES.md
  • docs/AI_INTERACTION_POLICY.md
  • docs/spec/SCREEN_SPEC.md
  • mikuscore-src.html
  • mikuscore.html

目的

この変更の主目的は以下です。

  • mikuscore の価値を「MusicXML-first な変換ツール」として読みやすくする
  • 利用者向け README と開発者向け文書の役割を分ける
  • ドキュメントと UI の説明文を同じプロダクト像に揃える

## 概要

`mikuscore` の説明を、開発者寄り・軽量エディタ寄りの見え方から、「MusicXML-first な譜面変換ツール」という位置づけに揃える変更です。
このコミットでは、`README.md` を利用者向けに再構成し、開発向け情報を `docs/DEVELOPMENT.md` に分離しています。あわせて、関連ドキュメントと `About mikuscore` の UI 文言も同じ方向に更新されています。

## 変更内容

### 1. `README.md` の再構成

`README.md` は、利用者向けの製品説明に寄せて大きく整理されています。

差分上で確認できる主な内容:
- `mikuscore` を MusicXML-first の score converter として説明
- `What mikuscore is for`
- `What mikuscore is not`
- `Core idea`
- `Supported formats`
- `Typical use cases`
- `Related projects`
- `Quick start`
- `Documents`
- 日本語セクションの再整理

### 2. 開発者向け情報の新設

新規ファイル `docs/DEVELOPMENT.md` が追加されています。

この文書には、差分上で以下の内容が含まれます。
- build / test / verification コマンド一覧
- CLI の開発者向けメモ
- documentation map
- AI interaction policy への導線
- debugging note
- `mikuscore-skills` および `miku-abc-player` が `mikuscore` を upstream dependency として取り込むことに関する注意

### 3. 周辺ドキュメントの位置づけ調整

以下の文書も、README と同じプロダクト像に合わせて更新されています。

- `docs/PRODUCT_POSITIONING.md`
- `docs/FORMAT_COVERAGE.md`
- `docs/CONVERSION_PRINCIPLES.md`
- `docs/AI_INTERACTION_POLICY.md`

差分上で確認できる方向性:
- `mikuscore` は notation editor ではなく変換ツールであることを明確化
- MusicXML-first / conversion / inspection / handoff の役割を強調
- AI は bridge use case の一つであり、製品の唯一の主軸ではないことを明示
- format coverage でも、lossless editing parity を約束するものではないことを補強

### 4. `About mikuscore` UI 文言の更新

`mikuscore-src.html` と生成物 `mikuscore.html` にある `About mikuscore` の tooltip 文言が更新されています。
また、`docs/spec/SCREEN_SPEC.md` の該当説明も同じ内容に合わせて更新されています。

差分上で確認できる変更例:
- `browser-based local score editor` から `browser-based MusicXML-first score converter` へ変更
- workflow を `Inspect the score and diagnostics` / `Export or hand off in another format` に寄せて更新
- MuseScore などの dedicated notation editor を使うべき場面を `notation editing` として明示

## 変更ファイル

- `README.md`
- `docs/DEVELOPMENT.md`
- `docs/PRODUCT_POSITIONING.md`
- `docs/FORMAT_COVERAGE.md`
- `docs/CONVERSION_PRINCIPLES.md`
- `docs/AI_INTERACTION_POLICY.md`
- `docs/spec/SCREEN_SPEC.md`
- `mikuscore-src.html`
- `mikuscore.html`

## 目的

この変更の主目的は以下です。

- `mikuscore` の価値を「MusicXML-first な変換ツール」として読みやすくする
- 利用者向け README と開発者向け文書の役割を分ける
- ドキュメントと UI の説明文を同じプロダクト像に揃える
@igapyon igapyon merged commit 5eab791 into devel Apr 14, 2026
@igapyon igapyon deleted the tiga0415hdj branch April 14, 2026 23:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant