ファイル形式の仕様を文書化する方法[終了]

プロジェクトでは、いくつかの古いゲームや関連ソフトウェアのさまざまな種類のファイル（構成ファイル、保存、リソースアーカイブなど）を扱う必要があります。これらの大部分はまだ文書化されておらず、それらを操作するためのツールも存在しないため、フォーマットをリバースエンジニアリングして、それらを処理するための独自のライブラリを構築する必要があります。

たいへん需要が多いとは思いませんが、成果を公表したいと思います。ファイル形式を文書化するための承認された標準はありますか？見回すと、いくつかのスタイルが使用されています。.ZIPファイル形式の仕様など、非常に冗長なスタイルがあります。XentaxWikiにあるような他のものはもっと簡潔です-それらのいくつかは読みにくいと思います。私が個人的に最も気に入っているのは、PlayStation 2メモリカードファイルシステムの説明です。これには、詳細な説明テキストとオフセットなどのいくつかの「メモリマップ」の両方が含まれます。これは、私のユースケースに最もよく一致します。フォーマットによって多少異なりますが、私が従おうとするいくつかの一般原則があるはずです。

編集：私が何をしたいのかよく説明していなかったようです。例を作ってみましょう。

構成を「バイナリ」ファイルに保存するいくつかの古いソフトウェアがあるかもしれません-一連のビットフィールド、整数、文字列、そしてすべてが結合されてプログラムによって理解されるわけではありませんが、人間が読めるものではありません。私はこれを解読します。このファイルを解析および変更するためのライブラリーを実装するための仕様として、このファイルの形式を人間が読める形式で正確に文書化したいと思います。また、他の人にもわかりやすいといいですね。

そのような文書が書かれるかもしれないいくつかの方法があります。上記のPKZIPの例は非常に冗長で、主にファイル形式をフリーテキストで記述しています。PS2の例では、値のタイプ、オフセット、およびサイズの表と、それらの意味を詳しく説明しています。XentaxWikiにあるような多くの他のものは、変数のタイプとサイズのみをリストし、ほとんどまたはまったくコメントしていません。

この種のドキュメントの書き方に関するガイダンスを提供するコーディングスタイルガイドに似た標準があるかどうかを尋ねます。そうでない場合、私がエミュレートする必要がある有名な優れた例はありますか？そうでない場合、誰かが少なくともいくつかの有用なアドバイスを要約できますか？

バイナリファイルは、特定の規則に従って論理ユニットに配置されたビットのシーケンスです。これらのルールは通常、文法と呼ばれます。文法は4つのタイプ（チョムスキー階層）に分類でき、Matt Fenwickのコメントで指摘されているように、文脈自由文法の場合はExtended Backus-Naur Formを使用する必要があります。ファイルに保存されたシーケンスの解釈（またはセマンティクス）は、口頭で、または情報をシリアル化および逆シリアル化した注釈付きのサンプルプログラムで説明できます。

バイナリファイル形式の文書化の詳細については、ASN.1標準などを参照することをお勧めします。

ファイル形式をすばやく検索するとWikipediaの記事（ファイル形式のリスト）が表示されるため、これは奇妙です。また、いくつかのビデオゲームデータ形式も含まれています。

ファイルシステムをサポートするシステム（最も一般的にはPCゲーム）でのビデオゲームのデータの一般的なファイル形式のリスト。

また、ビデオゲームストレージメディア形式の幅広い選択肢が含まれています。

ゲームのROMイメージまたはストレージメディアを元のROMデバイスからハードディスクなどの外部メモリにコピーして、バックアップの目的で、またはゲームをエミュレーターでプレイできるようにするときに使用される最も一般的なファイル名拡張子のリスト。カートリッジベースのソフトウェアの場合、プラットフォーム固有の拡張子を使用しないと、ファイル名拡張子「.rom」または「.bin」を使用して、ファイルにROMの内容のコピーが含まれていることを明確にします。通常、ROM、ディスク、またはテープイメージは、単一のファイルまたはROMではなく、ファイルまたはROM構造全体がバックアップメディア上の単一のファイルに含まれています。

ファイル形式を文書化するための承認された標準はありますか？

「公式」の基準はどこにもありません。ファイル形式は会社によって作成されるため、会社はドキュメントの形式を決定します。