ユーザ用ツール

サイト用ツール


ドキュメントの構成はパクる

ドキュメントの構成はパクる

目次はパクる、いや下敷きを使う

目次、すなわち文書全体の構成は、既存の文書を下敷きにする。

例えばある製品のマニュアルを作るときは、似たような製品のマニュアルをベースにし、非搭載の機能について削除し、新機能について追加する。

もちろんドキュメントの構成にもテンプレみたいな考え方はあると思う。最初に概要があり、使い方を説明し、重要な機能を順次説明していくような。ただ、そのテンプレ自体を実際に目にしたことがない。ドキュメントの種類によって細部が異なり、多彩なケースで使えるパターンがないからだろうか。単純に、既存のものを踏襲したほうが労力が少ないせいもあるだろう。

実際、数十人で作るようなドキュメントのプロジェクトでは、別プロジェクトのドキュメントを流用して構成を作っていた。また、製品のマニュアルでは常に既存のモデルを流用して制作しており、目次をゼロから作るなどということが無かった。目次どころか、個別のページもできるかぎり流用していた。

過去の経験からすると、ドキュメント制作においては、既存のものを下敷きにするのが王道だった。

ドキュメントの構成はパクる.txt · 最終更新: 2024/01/28 22:17 by 127.0.0.1

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki