technical-communication
プライベートノートを漏らさずに知識を公開する
社内文脈を露出せず、エンジニアリングノートを公開記事に変えるための実用的な手順。
プライベートノートは記録しやすさのために最適化されています。公開記事は知識を伝えるために最適化されています。この二つを同じ成果物として扱うと、読者には生の文脈が多すぎ、非公開の仕事情報が公開面に漏れるリスクも生まれます。
より安全なワークフロー
プライベートなナレッジベースは、Web サイトそのものではなく、素材として使います。
- 作業中はすべてをプライベートに記録する。
- 再利用できる原則、判断、チェックリスト、失敗パターンを抽出する。
- 公開読者を前提にノートを書き直す。
- 会社名、認証情報、時系列、顧客文脈、社内リンクを削除する。
- 編集済みのバージョンだけを公開する。
公開前チェックリスト
公開前に、記事内の次のリスクを確認します。
| リスク | 削除するもの |
|---|---|
| 認証情報 | Token、アカウント ID、プライベート endpoint |
| 社内文脈 | 会議メモ、顧客名、チケットリンク |
| 運用詳細 | インシデントの時系列、未公開の構成 |
| 個人情報 | 氏名、メールアドレス、プライベートメッセージ |
便利なデフォルトルール
ある段落が会社の文脈でしか意味を持たないなら、一般的なエンジニアリングの学びとして書き直すか、公開しない方が安全です。