Unit 7 / 11

Pengurusan Dokumentasi dan Maklumat: Runbook, Post-mortem dan Memori Korporat

Keuntungan:

  • Keupayaan untuk menghasilkan rangka buku panduan, bedah siasat dan dokumen seni bina daripada nota berselerak dengan kecerdasan buatan
  • Keupayaan untuk menguatkuasakan disiplin mengenakan 'larangan ke atas fabrikasi' dan menguji secara menyeluruh dan menandakan setiap buku panduan dalam persekitaran sebenar
  • Keupayaan untuk memahami bahawa buku panduan yang salah adalah lebih berbahaya daripada tiada dan memastikan dokumentasi hidup melalui proses perubahan

Pengurusan Dokumentasi dan Maklumat: Runbook, Seni Bina dan Ingatan Institusi dengan AI

Tugas pengurusan sistem yang paling diabaikan tetapi menyelamatkan nyawa ialah dokumentasi. Apabila sistem ranap dan orang yang membinanya sedang bercuti dan tiada perkataan bertulis tentang cara untuk pulih, ia adalah malam yang panjang untuk semua orang. Dokumentasi ialah ingatan institusi yang menyediakan cara sistem disediakan, cara ia berfungsi, dan perkara yang perlu dilakukan jika masalah berlaku. Jenis memori yang paling kritikal ialah buku panduan: panduan operasi yang memberitahu anda langkah demi langkah perkara yang perlu dilakukan dalam situasi tertentu (perkhidmatan ranap, cakera penuh, sandaran gagal). Di sini AI menyelesaikan masalah "halaman kosong" dan "kemalasan", yang merupakan musuh terbesar dalam menulis dokumentasi: ia menghasilkan buku panduan yang teratur daripada nota anda yang bertaburan, prosedur daripada sejarah arahan, penerangan daripada seni bina. Tetapi prinsip kritikal: AI menghasilkan cetak biru dan rangka; Andalah yang menguji dan mengesahkan setiap langkah untuk melihat sama ada ia benar-benar betul — buku jalan yang salah adalah lebih berbahaya daripada tiada buku jalan langsung.

Dalam unit ini, buku panduan, bedah siasat (laporan siasatan selepas kejadian), dokumentasi seni bina dan penulisan asas pengetahuan; Menjana draf dengan AI; dan yang paling penting anda akan mempelajari risiko dokumentasi yang tidak disahkan.

Mengapa buku panduan yang salah lebih teruk daripada buku panduan tidak?

Ini adalah konsep terpenting unit ini. Pasukan tanpa buku panduan berhati-hati dan curiga semasa panik; berfikir dua kali tentang setiap arahan. Tetapi seseorang yang mempunyai buku panduan "rasmi" mempercayainya secara membuta tuli — di tengah malam, dalam keadaan tertekan, melaksanakan langkah-langkah tanpa persoalan. Jika buku panduan itu dikeluarkan tanpa dihasilkan dan diuji oleh AI dan mempunyai satu langkah yang salah (perintah yang salah, prasyarat yang hilang, langkah sandaran yang dilangkau), hasilnya adalah bencana. Itulah sebabnya setiap buku panduan yang dihasilkan dengan AI mesti dijalankan dari awal hingga akhir dalam persekitaran sebenar dan setiap langkah mesti disahkan sebelum ia diterbitkan. Buku panduan yang belum diuji adalah seperti janji yang meyakinkan tetapi kosong.

Awas: Cop buku panduan dengan "diuji: [tarikh], [orang]". Tandai draf yang belum diuji dengan jelas dengan label "DRAF — TIDAK DISAHKAN." Jadi tiada siapa yang akan menggunakan langkah yang tidak disahkan dengan selamat dalam krisis sebenar.

Anatomi buku panduan yang baik

Buku panduan yang baik terdiri daripada bahagian-bahagian tertentu, dan AI pandai membina rangka itu: tajuk dan tujuan (untuk situasi apa), prasyarat (akses apa, alat apa yang diperlukan), simptom (bila saya menggunakan buku panduan ini), langkah-langkah (dengan arahan bernombor, boleh disalin), pengesahan (cara mengenali kejayaan selepas setiap langkah), gulung semula (bagaimana untuk membuat asal jika langkah menjadi tidak baik), dan saya fikirkan langkah itu (bagaimana saya boleh mengatasinya). Anda boleh memberikan AI nota bertaburan anda dan memintanya untuk memasukkannya ke dalam struktur ini; Anda hanya memastikan ketepatan kandungan.

Langkah demi langkah: Pengeluaran dokumentasi dengan AI

  1. Kumpulkan bahan mentah. Sejarah arahan anda, nota anda, e-mel lama, log sembang—bahan sebenar, walaupun tidak kemas, adalah lebih baik daripada fabrikasi AI.
  2. Minta struktur. "Jadikan ini sebagai buku panduan dengan tajuk berikut: tujuan, prasyarat, gejala, langkah, pengesahan, pemulangan semula, peningkatan."
  3. Haramkan fabrikasi. "Jangan tambah sebarang arahan, IP, versi atau langkah yang saya belum berikan kepada anda; tandakan mana-mana bahagian yang hilang sebagai [UNTUK DIISI]." Ini menghalang kesilapan yang paling berbahaya — langkah-langkah rekaan yang kelihatan munasabah.
  4. Topeng. Gunakan pemegang tempat dan bukannya hos sebenar, IP, pengguna; Sekiranya dokumen itu dikongsi, rahsia itu tidak boleh dibocorkan.
  5. Uji ia. Jalankan buku panduan dari awal hingga akhir dalam persekitaran sebenar (sebaik-baiknya ujian). Betulkan mana-mana langkah yang tidak berfungsi, hilang atau tidak jelas.
  6. Setem dan terbitkan. Tambahkan tarikh ujian, penguji dan kemas kini terakhir. Dokumentasinya meriah; Ia mesti dikemas kini apabila sistem berubah.

tiga kes mini

Kes 1 — 2 jam bekerja, 15 minit. Pentadbir telah menangguhkan mendokumentasikan prosedur pemulihan sandaran selama berbulan-bulan. Dia memberikan sejarah arahan terminal (bertopeng) dan beberapa nota bertaburan kepada AI dan memasukkannya ke dalam rangka kerja buku panduan. AI menghasilkan garis besar yang kemas dalam masa 15 minit. Pentadbir menghabiskan 45 minit seterusnya menjalankan draf dari awal hingga akhir pada pelayan ujian dan membetulkan dua langkah yang hilang. Hasilnya: buku panduan yang teruji dan boleh dipercayai.

Kes 2 — Ditangkap secara palsu. Sebuah pasukan meminta AI menulis buku panduan memulakan semula perkhidmatan tetapi terlupa untuk mengharamkan "fabrikasi". YZ menambah perintah "kosongkan cache dahulu", yang kelihatan logik tetapi tidak wujud dalam perkhidmatan itu. Nasib baik, jurutera menjalankan buku panduan dalam persekitaran ujian; Perintah itu memberikan ralat. Langkah ujian menangkap langkah yang dibuat-buat yang akan menimbulkan kekeliruan dalam krisis sebenar.

Kes 3 — Bedah siasat dipercepatkan. Selepas gangguan besar, pasukan itu perlu menulis bedah siasat, tetapi tiada siapa yang boleh bermula. Mereka menyerahkan garis masa acara dan log bertopeng kepada AI dan meminta rangka bedah siasat yang tidak bercela — ringkasan, impak, garis masa, punca punca, tindakan pembetulan. Pelan tindakan AI mengurangkan kerja sejam kepada sepuluh minit; Pasukan itu menumpukan tenaganya untuk mengesahkan fakta dan menjelaskan item tindakan.

Empat templat yang boleh disalin

1) Menjana rangka buku panduan:

Peranan anda: SRE kanan. Buat buku panduan daripada nota bertopeng/sejarah arahan di bawah. Tajuk: Tujuan, Prasyarat, Simptom (bila hendak digunakan), Langkah (bernombor, boleh disalin), Pengesahan pada setiap langkah, Rollback, Peningkatan. PERATURAN: Jangan buat sebarang arahan/IP/versi/langkah yang saya tidak berikan kepada anda; tulis bahagian yang hilang [UNTUK DIISI]. Bahan: [nota bertopeng]

2) Bedah siasat tanpa kesalahan:

Peranan anda: fasilitator penyiasatan insiden. Tulis lakaran bedah siasat BEBAS BLAME daripada garis masa dan log bertopeng berikut: Ringkasan, Kesan (tempoh/skop), Garis Masa, Punca Punca (jika disahkan), Faktor Penyumbang, Tindakan Pembetulan (pemilik + keutamaan). Jangan salahkan orang itu, fokus pada sistem. Jangan tulis punca tanpa bukti. Data: [...]

3) Perihalan seni bina/perkhidmatan:

Tulis dokumen perkhidmatan daripada maklumat konfigurasi/rajah bertopeng berikut: apa yang perkhidmatan itu lakukan, komponen apa yang terdiri daripadanya, apakah kebergantungannya, bagaimana aliran data, port/protokol apa. Pastikan ia teknikal tetapi boleh dibaca. Tandai perhubungan yang anda tidak pasti sebagai "memerlukan pengesahan". Maklumat: [bertopeng]

4) Audit penyemakan semula dokumentasi:

Semak dokumen sedia ada berikut dan semak mata wang: (1) apakah bahagian yang hilang/kabur, (2) apakah langkah yang kelihatan belum diuji, (3) apakah maklumat yang mungkin sudah lapuk? Tulis perkara yang perlu saya tanya/sahkan untuk setiap penemuan. Dokumen: [dokumen bertopeng]

Gesaan lemah / Gesaan kuat

Gesaan yang lemah:

Tuliskan saya buku panduan penyelenggaraan pelayan.

Tiada bahan sebenar. AI menghasilkan teks, sepenuhnya daripada pengetahuan amnya sendiri, yang tidak sesuai dengan persekitaran anda malah mengandungi langkah-langkah yang dibuat-buat. Ini adalah sumber keyakinan palsu yang berbahaya.

Gesaan kuat:

Peranan anda: SRE kanan. Di bawah ialah sejarah arahan bertopeng dan nota saya yang saya laksanakan dalam acara "cakera perkhidmatan pembayaran penuh". Cipta buku panduan daripada ini: Tujuan, Prasyarat (akses/alat), Gejala, Langkah Bernombor (dengan arahan saya), Pengesahan pada setiap langkah, Rollback, Peningkatan. Jangan buat saya mengikut arahan yang tidak saya berikan; Jadikan tempat kosong [UNTUK DIISI]. Letakkan amaran "tidak diuji" pada penghujungnya. Bahan: [sejarah arahan bertopeng]

Jenis dokumen

Sumbangan AI

Sumbangan wajib manusia

buku panduan

Rangka + susun atur

Pengujian dalam persekitaran sebenar, ketepatan

Bedah siasat

Garis besar + struktur

Sahkan fakta dan punca

dokumen seni bina

Penerangan + aliran

Sahkan perhubungan dan pergantungan

Artikel asas pengetahuan

draf cepat

Semakan semasa dan ketepatan

Kesilapan biasa

  • Menerbitkan buku jalanan yang belum diuji. Langkah-langkah yang tidak disahkan dilaksanakan secara membuta tuli dalam krisis; Buku panduan yang salah adalah bencana.
  • Bukan untuk mengenakan larangan ke atas rekaan. Jika anda tidak memberitahu AI "jangan tambah apa yang saya belum berikan", ia akan menghasilkan langkah yang munasabah tetapi tidak realistik.
  • Melangkau topeng. Rahsia itu bocor apabila dokumen yang mengandungi hos sebenar, IP dan pengguna dikongsi.
  • Tidak mengemas kini dokumen. Dokumen yang tidak dikemas kini apabila sistem berubah menjadi mengelirukan dari semasa ke semasa.
  • Menerbitkan tanpa setem. Tidak jelas sama ada dokumen tanpa tarikh dan status ujian boleh dipercayai atau draf.
Petua: Cara terbaik untuk memastikan dokumentasi "langsung" adalah dengan mengikatnya dengan proses perubahan: apabila sistem berubah, biarkan pengemaskinian buku jalan yang berkaitan menjadi salah satu kriteria penyelesaian untuk perubahan. AI mempercepatkan kemas kini, tetapi anda adalah proses pencetus.

Secara ringkasnya

Dokumentasi ialah ingatan institusi; Buku panduan ialah panduan operasi yang menyelamatkan nyawa semasa krisis. AI menghasilkan draf tersusun daripada nota berantakan anda, menyelesaikan masalah halaman kosong dan kemalasan. Tetapi kebenaran yang paling kritikal ialah ini: buku panduan yang salah adalah lebih berbahaya daripada tidak sama sekali kerana ia digunakan secara membuta tuli dalam krisis. Jadi larang AI daripada "membuat", menutupinya, dan menguji dengan teliti dan mengecap setiap buku panduan dalam persekitaran sebenar. Pastikan dokumen hidup semasa sistem berubah. AI membina rangka kerja; Anda adalah orang yang menjamin ketepatan dan ujian.

Tugasan permohonan

Pilih prosedur yang tidak didokumenkan dalam pasukan anda (contohnya, memulakan semula perkhidmatan atau memulihkan sandaran). Tutup sejarah arahan dan nota anda yang berkaitan dan minta AI membuat draf menggunakan templat "Runbook skeleton generation" di atas; Pastikan anda mengenakan larangan ke atas rekaan. Jalankan draf dalam persekitaran ujian dan benderakan dan betulkan mana-mana langkah yang rosak/hilang. Tambahkan tarikh ujian dan maklumat penguji pada buku panduan. Tuliskan perbezaan yang dihasilkan oleh AI dan anda betulkan dalam proses itu dalam 5 item.

senarai semak

  • [ ] Saya mencipta buku panduan daripada bahan sebenar (nota, sejarah arahan), bukankah saya membuatnya dari awal?
  • [ ] Adakah saya telah melarang AI ​​daripada "menambah arahan/IP/langkah yang belum saya berikan"?
  • [ ] Adakah saya telah menyembunyikan maklumat sensitif seperti hos, IP dan pengguna?
  • [ ] Adakah saya telah menjalankan dan mengesahkan buku panduan dalam persekitaran sebenar/ujian?
  • [ ] Adakah saya telah menambah tarikh ujian, penguji dan maklumat kemas kini terakhir?
  • [ ] Adakah saya merancang untuk memautkan dokumen kepada proses perubahan sistem dan memastikan ia dikemas kini?