機械可読仕様書の記述ガイドブック(案)

本書のステータス: ドラフト(DS シリーズ素案)。本書は将来デジタル社会推進標準ガイドライン群 (DS シリーズ)に組み込むことを前提に、その様式を踏襲して作成した素案である。DS 番号は未採番で あり、本書では仮置きとして ds-4xx(4 番台のいずれか)と表記する。正式番号は確定時に採番する。

項目内容
ドキュメントの位置付けNormative(機械可読仕様書をテキストで正本化する際に遵守する記述規約)
キーワード機械可読仕様書、MRSS、正本、テキストオーサリング、Markdown、YAML frontmatter、payload、Open Knowledge Format、型記法、規範文、告示プロジェクション、URN、トレーサビリティ、行政事務標準文字、版管理
概要標準仕様書を Word/Excel から変換して掲載するのではなく、テキスト(Markdown/YAML)そのものを正本としてオーサリングする場合の記述ルールを定める。1 概念 = 1 ファイル、frontmatter による索引、payload による型付き正本、規範文の byte 保持、URN によるトレーサビリティ、文字標準への準拠、Git による版管理を規定する。住民記録システム標準仕様(業務 001)を全編にわたる実例として参照する。

本書の目的

現在、標準仕様書は Word/Excel で作成され、それを Markdown/YAML へ変換して掲載している。変換は 原本の体裁(自動採番・setext 見出し・pandas ダンプ表・PUA グリフ等)に起因する崩れを伴い、変換器が 原本の癖を吸収し続ける必要がある。

本書は発想を逆転し、最初からテキストを正本として書く場合に、人間・AI・プログラムのいずれもが 等しく扱える仕様書とするための記述ルールを定める。テキストを正本とすれば、Git による差分・レビュー・ 版管理がそのまま仕様の改訂プロセスになり、変換の往復で情報が失われることもない。

本書が定めるフォーマットは、これまで mrlgss が運用してきた 2 つのプロファイル (軽量な文書索引層 mrlgss-doc/0.1 と、型付き正本層 chimata-okf/0.1)を、オーサリングの観点から 一本に統合したものである。

想定読者

  • 標準仕様の所管(制度官庁)で、仕様書を起草・改訂する担当者
  • 仕様書を機械可読化する技術者
  • 仕様書を参照して実装するベンダー開発者・自治体職員(記述の意味を正しく読み取るため)

章構成

改定履歴

改定年月日改定箇所改定内容
2026年6月16日全体草案を新規作成(mrlgss-doc/0.1chimata-okf/0.1 の 2 プロファイルを統合)