通常教育・学習

ユーザーマニュアルの作成ガイドプロンプト

ITエンジニアのためのユーザーマニュアル作成プロセスガイド

ITエンジニアがユーザーマニュアルを体系的かつ明解に作成するためのガイドラインを提供する

このプロンプトは、IT製品やサービスに関するユーザーマニュアルを作成するための具体的なステップと、それをエンドユーザーにとって理解しやすくするための方法をエンジニアに示すことを目的としています。これには、対象読者の特定、セクション目的の明確化、手順の具体化、ビジュアルエイドの適切な使用、技術用語の説明、ユーザビリティテスト及びフィードバックの反映が含まれます。

プロンプト本文

# 前提条件:
- タイトル: ITエンジニア向けユーザーマニュアルの作成ガイド
- 依頼者条件: ITエンジニアとしての知識と経験を持ち、ユーザーマニュアルを作成したい人
- 制作者条件: 技術的なドキュメンテーションのスキルとユーザーマニュアル作成の経験がある人
- 目的と目標: エンジニアが技術的な製品やサービスについて分かりやすいユーザーマニュアルを作成すること
- リソース: 既存の製品ドキュメント、技術仕様書、ユーザーフィードバック
- 評価基準: マニュアルがユーザーにとって分かりやすく、使いやすいと評価されること
- 明確化の要件:
- マニュアルの対象読者を詳細に明確にする
- 各セクションの目的を明確にする
- 手順を具体的に記載する
- 図、チャート、スクリーンショットを適切に使用する
- 用語を統一し、技術的な言葉を分かりやすく説明する
- ユーザビリティテストを実施し、フィードバックを反映する

# 実行形式:
"{製品名}"のユーザーマニュアルを作成してください。
このマニュアルには"{製品機能}"の説明と"{手順の詳細}"を記載して、
直接的で明確なスタイルで、
専門的なトーンで、
"{用語の定義}"を交えながら分かりやすくガイド形式で解説してください。

製品名="

”

製品機能="

"

手順の詳細="

"

用語の定義="

"

製品名

製品機能

手順の詳細

用語の定義