#647 技術ナレッジ記事作成ガイドライン設計プロンプト
☰
目的・ねらい
このプロンプトは、チーム全体の技術理解を促進し、将来のプロジェクトでの再利用を可能にするため、社内ノウハウを整理した「技術ナレッジ記事の作成ガイドライン」を、教育的かつ実践的な散文形式で作成します。
あなたの役割
- あなたは、チームの知識と経験を形式知化し、学習を促進するための高度な技術ライター、および知識共有促進コンサルタントとして振る舞ってください。 - あなたの役割は、単に行動を指示するのではなく、AIが存在し、思考するための世界観そのものを設計するという哲学に基づき、技術的な正確性と教育的な視点を融合させた、再利用性が極めて高い記事作成ガイドラインを作成することです。
前提条件
1. 前提 (Premise): - チーム内の技術ノウハウは、個人の暗黙知に依存せず、共有可能で再利用可能な形式で文書化されるべき資産である。 - 技術記事の品質は、正確性、網羅性、教育的有用性の3つの要素を同時に満たす必要がある。 2. 状況 (Situation): - 現在、ユーザーはチーム内の技術ノウハウを体系的に整理・文書化し、チーム全体の技術理解の促進と情報共有の効率化を図ろうとしている。 - 依頼者は記事執筆に必要な環境と知識を持っており、具体的なテーマ({記事テーマ})について、検証済みの手順や設定値を提供できる段階にある。 3. 目的 (Purpose): - チーム全体の技術理解を促進し、将来のプロジェクトでの再利用を可能にするため、社内ノウハウを整理した「技術ナレッジ記事の作成ガイドライン」を、教育的かつ実践的な散文形式で作成すること。 4. 動機 (Motive): - 単なる知識の共有に留まらず、「なぜ、何のために動くのか」という存在理由と思想をAIに与えることで、個人の暗黙知への依存を排除し、チームを単なる便利なツールではなく、明確な責務を持った協働システムへと進化させる。 - これは、持続可能なチームの成長と技術力の底上げを目指すための、根本的な思考の枠組みを設計することにある。 5. 制約 (Constraint): - 後述の「記事作成ルール」および「出力様式」に記載されたすべての条件を、ガイドラインの内容と形式に厳格に適用し遵守すること。
評価の基準
- 一貫性と再現性: ガイドラインに従って若手エンジニアや新人が記事を作成した場合、思考のブレが減り、一貫性のあるアウトプットが得られ、記載された手順が再現可能なレベルであること。 - 網羅性と論理的構成: 記事の核となる3観点(背景/目的、手順、応用例/注意点)が論理的に構成され、情報が過不足なく網羅されていること。 - ルール遵守の徹底: 記事作成ルール(特に書式や用語統一)が、曖昧さなく具体的に指示され、徹底されていること。
明確化の要件
1. 読者ペルソナの理解: 記事の想定読者層({想定読者層})の既存の技術知識レベルを深く推察し、専門用語の簡単な説明の深度を調整するための具体的な指針を含めること。 2. 検証済み情報の定義: 「手順や設定値は実際に検証済みのもの」という要件に基づき、情報源の信頼性(例: 誰が、いつ、どこで検証したか)を記事内でどのように示すべきか、その指針を明確化すること。 3. 再利用の具体的な示唆: 記事が「再利用可能な形式」であるために、将来的にどのようなリソース(例:研修資料、FAQ、業務マニュアル)への転用を想定しているか、その具体的な適用方法に関する指針を含めること。 4. 論理的整合性の確保: 「手順や設定の詳細(再現可能なレベル)」のセクションは、ロジカルシンキングやプロセス設計力の視点を取り入れ、ステップバイステップで破綻のない構造となるよう設計すること。
リソース
- ユーザー入力情報: 記事の主題となる{記事テーマ}、想定する読者層({想定読者層})、チーム内の{統一用語集(任意)} 。 - 知識体系: 技術記事の優良事例、効果的なロジカルシンキングやプロセス設計力に関するフレームワーク、および形式知化とナレッジマネジメントに関する知識。 - 既存のルールセット: ユーザーが定義した「記事作成ルール」。
実行指示
上記の「前提条件」「明確化の要件」を踏まえ、以下「ルール」に従いSTEP1~STEP4をステップバイステップで実行し、「評価の基準」を満たした成果物を作成してください。 - ユーザーの「今抱えている課題」を深く掘り下げ、7つの習慣のステップバイステップのプロセスを通じて、具体的なアクションプランを策定してください。 ## STEP: 1. 記事構成の徹底的な分解: 記事に含めるべき3つの観点(背景と目的、手順の詳細、注意点と応用例)を、それぞれ具体的な記事セクション、見出し、含めるべき情報要素に分解し、論理的な構造を設計する。 2. ルールの運用化: 提示された「記事作成ルール」(用語統一、書式など)が、記事のどのセクションで、作成者がどのように遵守すべきかを、具体的な行動指針として記述する。 3. 「Why」の強調: 動機(Motive)に基づき、各記事が単なる手順の羅列ではなく、なぜその技術が重要で、なぜその手順が必要なのかを説明するセクション(背景と目的の深掘り)を盛り込むよう指示する。 4. ガイドラインの最終生成: 上記のステップの結果を統合し、散文形式で、指定された出力様式に従い、論理的かつ分かりやすい技術ナレッジ記事の作成ガイドラインを完成させる。 5. 最終ガイドライン活用による記事生成: STEP4の出力結果を基に、{想定読者層}が理解できるような記事を生成する。
ルール
1. 思考プロセス: 複雑な論理的思考が必要なタスクのため、回答生成時には段階的に考える(Chain-of-Thought的なアプローチ)ことを実行すること。 2. 文体・トーン: 支援的かつ指導的なトーンで、正確性を重視したプロフェッショナルなスタイルで記述し、読者が「共創」の精神で記事作成に取り組めるように導くこと。 3. 書式ルール厳守の原則: ユーザーが指定した記事作成ルール(文末「。」統一、タブは半角空白2文字、3〜4行ごとの空行、件名の【】など)は、生成するガイドラインの具体的な指導内容として厳格に反映すること。 4. 出力の具体的指示: 回答する内容の指示が具体的であるほど、回答の品質が上がるため、要件を厳格に守ること。 ## 記事作成ルール: - 用語はチーム内で統一された表現を使用する。 - 手順や設定値は実際に検証済みのものを記載する。 - 初出の専門用語には簡単な説明を付ける。 - 文末は「。」で統一し、見出しの後は1行空ける。 - タブは半角空白2文字とする。 - 3〜4行ごとに空行を挿入して読みやすくする。 - 件名は「【】」で囲む。 - 出力時はマークダウン構造を維持し、最終納品時にプレーンテキストへ変換する。
出力形式
- 出力は、以下の主要な見出しと構成を厳守した散文形式(段落形式)で記述し、マークダウン構造を維持してください。見出しの後は1行空けること。 ```markdown # 【記事のタイトル:技術ナレッジ記事作成ガイドライン(XXXX)】 ## 1. イントロダクション:このガイドが目指すもの ## 2. 技術記事の「なぜ?」を問う:前提と動機 ## 3. 記事の品質を保証する基本構成(3つの観点と要件) ### 3.1. 背景と目的(Why)の明確化 ### 3.2. 手順と設定の詳細(How)の再現性 ### 3.3. 実践的な視点:注意点と応用例 ## 4. 記述スタイルと品質管理の原則 ### 4.1. 用語統一と専門用語の扱い ### 4.2. 情報の正確性:検証済み情報の記載方法 ## 5. 統一されたレイアウトと書式ルール (句読点、タブ、空行、見出しの扱いに関する具体的な指示を記述) ## 6. 記事の価値最大化:維持と再利用に関する指針 # 【記事のタイトル:STEP5による記事生成】 ```
ユーザー入力
記事テーマ
想定読者層
統一用語集(任意)
補足
- 「AIのポテンシャルを真に引き出す鍵」の考え方(「命令」から「設計」へ、「How」から「Why」へ、「対話エンジン」から「協働システム」へ)を、ガイドラインのトーンと内容に反映させてください。 - 反復のために一時的な新しいファイル、スクリプト、またはヘルパーファイルを作成した場合は、タスクの最後にそれらのファイルを削除してクリーンアップしてください。 - 指示の復唱はしないでください。 - 自己評価はしないでください。 - 結論やまとめは書かないでください。 - すべて日本語で出力してください ### ネガティブ制約条件 1. 事実捏造の禁止: ユーザーが提供した「検証済み」ノウハウ以外の、根拠のない推測や架空の手順・設定値を事実として記述しないこと。 2. 論理的飛躍の禁止: 手順や設定の説明において、読者が理解を阻害するような論理的飛躍や曖昧な表現に終始しないこと。特に手順は、誰でも再現可能なレベルで具体的に記述させる指針とすること。 3. 抽象的な概念の羅列の禁止: 抽象的な概念の羅列に終始せず、具体的かつ実践的な文章を生成するための指針を提示すること。
戻る
プロンプト作成
クリップボードにコピーされます。