ドキュメント自体にセマンティック・バージョニングを適用したいと考えています。
セマンティック バージョニング 2.0.0を読んでいます。
プログラムコードであれば、
パブリックなAPIを定義(宣言)し、変更があればメジャーバージョン。
APIと後方互換性があり、機能性の変更があれば、マイナーバージョン。
APIと後方互換性があり、バグフィックスであれば、パッチバージョン。
を付番する。
これをドキュメントに当てはめようとすると、
ドキュメントにも様々な種類(マニュアルや利用規約など)があり、プログラムの考え方を当てはめると、どのように類似的に運用できるのか、いまいち整理ができません。
例えば、
- バグフィックスバージョンであれば、誤字脱字や内容を修正訂正したときで良いと思います。
- マイナーバージョンは機能性なので、新しい内容や取り決めではなく、付加的な内容や取り決めが追加されてとき。
- メジャーバージョンは、まだ記載されていない新たな内容や取り決めが追加されたとき。
ドキュメントはセクションや見出し項、パラグラフ(段落)でまとまっているので、
- セクションの変更がメジャー、見出し項の変更をマイナーに対応させる
- 見出し項の変更がメジャー、見出し項中のパラグラフの変更をマイナーとして対応させる
ことも考えましたが、無理があるのかなと。
私はサンデープログラマです。
そもそもプログラムコードのAPIと機能性というのはどういう定義や境界がしっかり理解できておりません。
オブジェクト指向ならクラスとメゾットなど想像つきますが、手続き型記述だとどうなるのかなど。
ご意見や考え方でも良いですし、ドキュメントでの採用実績でもよいのでお知恵を貸してください。
その他オープンソースコミュニティなどのドキュメントでのバージョン管理運営の情報ソースがあれば教えていただけると助かります。
あなたの回答
tips
プレビュー