質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

新規登録して質問してみよう
ただいま回答率
85.48%
ドキュメント

ドキュメントは、IT用語では、ソフトウェアやハードウェアに関する情報であり、意図された目的、機能性、メインテナンスを含みます。ドキュメントは、多くの様々なフォームとフォーマットに存在しますが、その目的は常に教育することにあります。

バージョン管理

バージョン管理はコンピューター上にファイルとして格納されているドキュメント・プログラム・その他の情報の変更履歴等を管理するものです

Q&A

0回答

286閲覧

ドキュメントにセマンティック・バージョニングを適用したいと考えていますが。。。

SmokeyBlues

総合スコア22

ドキュメント

ドキュメントは、IT用語では、ソフトウェアやハードウェアに関する情報であり、意図された目的、機能性、メインテナンスを含みます。ドキュメントは、多くの様々なフォームとフォーマットに存在しますが、その目的は常に教育することにあります。

バージョン管理

バージョン管理はコンピューター上にファイルとして格納されているドキュメント・プログラム・その他の情報の変更履歴等を管理するものです

0グッド

1クリップ

投稿2022/06/06 08:39

編集2022/06/06 08:41

ドキュメント自体にセマンティック・バージョニングを適用したいと考えています。
セマンティック バージョニング 2.0.0を読んでいます。

プログラムコードであれば、
パブリックなAPIを定義(宣言)し、変更があればメジャーバージョン。
APIと後方互換性があり、機能性の変更があれば、マイナーバージョン。
APIと後方互換性があり、バグフィックスであれば、パッチバージョン。
を付番する。

これをドキュメントに当てはめようとすると、
ドキュメントにも様々な種類(マニュアルや利用規約など)があり、プログラムの考え方を当てはめると、どのように類似的に運用できるのか、いまいち整理ができません。

例えば、

  • バグフィックスバージョンであれば、誤字脱字や内容を修正訂正したときで良いと思います。
  • マイナーバージョンは機能性なので、新しい内容や取り決めではなく、付加的な内容や取り決めが追加されてとき。
  • メジャーバージョンは、まだ記載されていない新たな内容や取り決めが追加されたとき。

ドキュメントはセクションや見出し項、パラグラフ(段落)でまとまっているので、

  • セクションの変更がメジャー、見出し項の変更をマイナーに対応させる
  • 見出し項の変更がメジャー、見出し項中のパラグラフの変更をマイナーとして対応させる

ことも考えましたが、無理があるのかなと。

私はサンデープログラマです。
そもそもプログラムコードのAPIと機能性というのはどういう定義や境界がしっかり理解できておりません。
オブジェクト指向ならクラスとメゾットなど想像つきますが、手続き型記述だとどうなるのかなど。

ご意見や考え方でも良いですし、ドキュメントでの採用実績でもよいのでお知恵を貸してください。
その他オープンソースコミュニティなどのドキュメントでのバージョン管理運営の情報ソースがあれば教えていただけると助かります。

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

まだ回答がついていません

会員登録して回答してみよう

アカウントをお持ちの方は

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.48%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問