ドキュメントの構成はパクる
差分
このページの2つのバージョン間の差分を表示します。
| 次のリビジョン | 前のリビジョン | ||
| ドキュメントの構成はパクる [2023/08/13 16:40] – 作成 kanrisha | ドキュメントの構成はパクる [2024/01/28 22:17] (現在) – 外部編集 127.0.0.1 | ||
|---|---|---|---|
| 行 2: | 行 2: | ||
| ===== 目次はパクる、いや下敷きを使う ===== | ===== 目次はパクる、いや下敷きを使う ===== | ||
| - | 目次、すなわち文書全体の構成は、既存の文書を下敷きにすべきた。例えばある製品のマニュアルを作るときは、似たような製品のマニュアルをベースにし、機能の有無で不要な項目を削除/追加する。 | + | 目次、すなわち文書全体の構成は、既存の文書を下敷きにする。 |
| + | |||
| + | 例えばある製品のマニュアルを作るときは、似たような製品のマニュアルをベースにし、非搭載の機能について削除し、新機能について追加する。 | ||
| もちろんドキュメントの構成にもテンプレみたいな考え方はあると思う。最初に概要があり、使い方を説明し、重要な機能を順次説明していくような。ただ、そのテンプレ自体を実際に目にしたことがない。ドキュメントの種類によって細部が異なり、多彩なケースで使えるパターンがないからだろうか。単純に、既存のものを踏襲したほうが労力が少ないせいもあるだろう。 | もちろんドキュメントの構成にもテンプレみたいな考え方はあると思う。最初に概要があり、使い方を説明し、重要な機能を順次説明していくような。ただ、そのテンプレ自体を実際に目にしたことがない。ドキュメントの種類によって細部が異なり、多彩なケースで使えるパターンがないからだろうか。単純に、既存のものを踏襲したほうが労力が少ないせいもあるだろう。 | ||
| - | 実際、数十人で作るようなドキュメントのプロジェクトでは、別プロジェクトのドキュメントを流用して構成を作っていた。また、製品のマニュアルでは**常に**既存のモデルを流用して制作しており、目次をゼロから作るなどということが無かった。 | + | 実際、数十人で作るようなドキュメントのプロジェクトでは、別プロジェクトのドキュメントを流用して構成を作っていた。また、製品のマニュアルでは**常に**既存のモデルを流用して制作しており、目次をゼロから作るなどということが無かった。目次どころか、個別のページもできるかぎり流用していた。 |
| 過去の経験からすると、ドキュメント制作においては、既存のものを下敷きにするのが王道だった。 | 過去の経験からすると、ドキュメント制作においては、既存のものを下敷きにするのが王道だった。 | ||
ドキュメントの構成はパクる.1691912432.txt.gz · 最終更新: 2024/01/28 22:15 (外部編集)