社内ナレッジ記事
- 対象者:
- 作成者:
- 最終確認日: YYYY/MM/DD
その他GEN-04
対象者、前提条件、手順、確認方法、つまずき、最終確認日をそろえ、古くならない記事にします。
# 社内ナレッジ記事
- 対象者:
- 作成者:
- 最終確認日: YYYY/MM/DD
## この記事で分かること
-
## 手順
1.
2.
3.
## よくあるつまずき
-
## 関連情報
-
| 項目 | 内容 |
|---|---|
| タイトル | |
| 対象者 | |
| 作成者 | |
| 作成日 | YYYY/MM/DD |
| 最終確認日 | YYYY/MM/DD |
| キーワード |
| 症状 | 原因 | 対処 |
|---|---|---|
| 日付 | 内容 | 更新者 |
|---|---|---|
| YYYY/MM/DD | 作成 |
# 社内ナレッジ記事
<!-- タイトルは「〜する方法」「〜のときの対処」のように、読者が検索する言葉で付ける -->
## 記事情報
| 項目 | 内容 |
| --- | --- |
| タイトル | |
| 対象者 | |
| 作成者 | |
| 作成日 | YYYY/MM/DD |
| 最終確認日 | YYYY/MM/DD |
| キーワード | |
## 1. この記事で分かること
<!-- 1〜3 行で、読むと何ができるようになるかを書く -->
-
## 2. 前提条件
- 必要な権限:
- 必要なツール・環境:
- 事前に読む記事:
## 3. 手順
1.
2.
3.
## 4. 確認方法
<!-- 手順がうまくいったことを、どう確認するか -->
-
## 5. よくあるつまずき
| 症状 | 原因 | 対処 |
| --- | --- | --- |
| | | |
## 6. 関連情報
- 関連記事:
- 公式ドキュメント:
- 問い合わせ先:
## 7. 更新履歴
| 日付 | 内容 | 更新者 |
| --- | --- | --- |
| YYYY/MM/DD | 作成 | |
| 項目 | 内容 |
|---|---|
| タイトル | |
| 記事の種類 | 手順 / トラブルシューティング / 解説 / FAQ |
| 対象者 | |
| 難易度 | 初級 / 中級 / 上級 |
| 所要時間 | 分 |
| 作成者 | |
| 管理者(問い合わせ先) | |
| 作成日 | YYYY/MM/DD |
| 最終確認日 | YYYY/MM/DD |
| 次回確認予定 | YYYY/MM/DD |
| 公開範囲 | 全社 / 部署内 / チーム内 |
| キーワード |
| 項目 | 内容 |
|---|---|
| 必要な権限 | |
| 必要なツール・環境 | |
| 対象のバージョン | |
| 事前に読む記事 |
# 実行するコマンドを記載する
注意: 取り消せない操作や、本番環境に影響する操作はここに書く
| 症状(エラーメッセージ) | 原因 | 対処 |
|---|---|---|
| 種類 | リンク | 補足 |
|---|---|---|
| 関連記事 | ||
| 公式ドキュメント | ||
| 関連チケット |
| 用語 | 説明 |
|---|---|
| 日付 | 内容 | 更新者 |
|---|---|---|
| YYYY/MM/DD | 作成 |
# 社内ナレッジ記事
<!-- タイトルは「〜する方法」「〜のときの対処」のように、読者が検索する言葉で付ける -->
<!-- 最終確認日から一定期間(例: 1 年)経った記事は、内容を確認して更新するか、アーカイブする -->
## 記事情報
| 項目 | 内容 |
| --- | --- |
| タイトル | |
| 記事の種類 | 手順 / トラブルシューティング / 解説 / FAQ |
| 対象者 | |
| 難易度 | 初級 / 中級 / 上級 |
| 所要時間 | 分 |
| 作成者 | |
| 管理者(問い合わせ先) | |
| 作成日 | YYYY/MM/DD |
| 最終確認日 | YYYY/MM/DD |
| 次回確認予定 | YYYY/MM/DD |
| 公開範囲 | 全社 / 部署内 / チーム内 |
| キーワード | |
## 1. この記事で分かること
<!-- 1〜3 行で、読むと何ができるようになるかを書く -->
-
## 2. 背景
<!-- なぜこの作業・知識が必要になるのか -->
-
## 3. 前提条件
| 項目 | 内容 |
| --- | --- |
| 必要な権限 | |
| 必要なツール・環境 | |
| 対象のバージョン | |
| 事前に読む記事 | |
## 4. 手順
### 4.1 (手順のまとまり)
1.
2.
```bash
# 実行するコマンドを記載する
```
> 注意: 取り消せない操作や、本番環境に影響する操作はここに書く
### 4.2 (手順のまとまり)
1.
2.
## 5. 確認方法
<!-- 手順がうまくいったことを、どう確認するか -->
-
## 6. よくあるつまずき
| 症状(エラーメッセージ) | 原因 | 対処 |
| --- | --- | --- |
| | | |
## 7. よくある質問
- Q:
- A:
## 8. 関連情報
| 種類 | リンク | 補足 |
| --- | --- | --- |
| 関連記事 | | |
| 公式ドキュメント | | |
| 関連チケット | | |
## 9. 用語
| 用語 | 説明 |
| --- | --- |
| | |
## 10. 更新履歴
| 日付 | 内容 | 更新者 |
| --- | --- | --- |
| YYYY/MM/DD | 作成 | |
社内の手順やノウハウを、対象者が検索して見つけ、そのまま再現できる形で残すための記事テンプレートです。