ドキュメント基本用語

ストーリー

「テンプレートに沿って書いてね」「フォーマットを揃えて」「バージョン管理も忘れずに」

先輩の指示に出てくる言葉が、何となく分かるけど正確には分からない。

「まずは用語を整理しよう。言葉の意味がはっきりすれば、指示も正確に理解できるよ」

基本用語一覧

ドキュメント（Document）

技術的な内容を記録した文書全般を指します。

広い意味:
  議事録、手順書、設計書、README、仕様書...すべて「ドキュメント」

狭い意味:
  コードに付随する説明文書（APIドキュメントなど）

「ドキュメントを書いて」と言われたら、文脈に応じてどの文書か確認しましょう。

テンプレート（Template）

文書のひな形です。あらかじめ構成や項目が決まっていて、中身を埋めるだけで文書が完成します。

テンプレートの例（議事録）:
  ┌────────────────────────┐
  │ 日時: ___              │ ← ここを埋める
  │ 参加者: ___            │ ← ここを埋める
  │ アジェンダ:            │
  │  1. ___                │ ← ここを埋める
  │ 決定事項:              │
  │  - ___                 │ ← ここを埋める
  │ アクションアイテム:     │
  │  - [ ] ___             │ ← ここを埋める
  └────────────────────────┘

テンプレートのメリット:

• 何を書けばいいか迷わない
• 書き漏れを防げる
• チーム内で品質が均一になる

フォーマット（Format）

文書の書式や形式のことです。2つの意味で使われます。

「フォーマットを揃えて」
  → 書式を統一してください（見出しの使い方、日付の表記などを合わせる）

「どのフォーマットで提出？」
  → どのファイル形式で提出する？（Markdown？ PDF？）

バージョン管理（Version Control）

文書の変更履歴を管理することです。

よくないバージョン管理:

議事録_v1.md
議事録_v2.md
議事録_v2_修正.md
議事録_最終版.md
議事録_最終版_本当の最終版.md   ← どれが最新？

正しいバージョン管理:

Gitで管理:
  commit 1: 議事録を作成
  commit 2: 決定事項を追加
  commit 3: アクションアイテムを修正
  → 常に最新版が1つ。過去の変更も全て記録されている

Git（月2で学んだ内容）を使えば、ドキュメントのバージョン管理もできます。

レビュー（Review）

他の人に文書を確認してもらうことです。

レビューの流れ:
  1. 文書を書く
  2. 先輩やチームメンバーに確認してもらう（レビュー依頼）
  3. フィードバックを受ける
  4. 修正する
  5. 最終版として確定する

その他よく使う用語

まとめ

• 基本用語の意味を理解した
• テンプレートとフォーマットの違いが分かった
• バージョン管理の重要性を確認した

次のステップへ

基本用語は整理できましたか？

次はStep 1の理解度チェックです。 ここまで学んだ「ドキュメントの種類」「Markdown」「基本用語」の内容をクイズで確認しましょう。

推定読了時間: 15分