ナレッジの書き方
はじめに
Webチームでは、皆さんに案件ごとのナレッジの提出をお願いしています。
この記事では、ナレッジの書き方や注意事項についてまとめているので、ぜひ参考にしてください。
タイトル
基本的には、「【案件名】○○についてor○○の方法」という形でタイトルを付けてください。
例)【サテライトサイト】フッターにSNSアイコンを表示する方法
本文
1. 前提
・各種環境(わかる範囲で。PCスペック、WordPressのバージョン、テンプレート、プラグインなど)
・実現したいこと
基本的にはタイトルの内容に補足する感じで大丈夫です。
2. 結論
1を達成することが出来た方法を簡潔に書いてください。
3. 具体内容
2について具体的に記載します。
他のWebチームのメンバーも参照するので、分かりやすさを意識して作成してください。
PC画面のキャプチャやサイトのリンクを載せることも可能です。
注意事項
・案件を行う上で躓いたところ、またはWeb運用メンバーに質問して解決したところをナレッジにまとめること(同案件を複数人で対応する場合は、誰がどのトピックでナレッジを書くかを事前に決める)
・ナレッジを書き終えたら下書き保存し、SlackのWeb制作のチャンネルでWeb運用メンバーに報告すること(確認が終わり次第、Web運用メンバーが更新します。)
・その他、不明点があればWeb制作チャンネルでWeb運用メンバーに質問してください。