Saya telah menjadi mitra dalam layanan kontrak / konsultasi tiga orang sejak Juni 2004. Kami masing-masing terutama mengerjakan "akun" kami sendiri, namun kami harus memelihara dokumentasi satu sama lain untuk memungkinkan "kegagalan" antara mitra. Sebagian besar Pelanggan kami memiliki beberapa jenis staf TI internal, banyak dari mereka melakukan sejumlah pemeliharaan sehari-hari, dan kami juga perlu mengkomunikasikan dokumentasi kepada mereka secara efektif.
Dua mitra saya memiliki keuntungan (jika Anda bisa menyebutnya demikian) karena pernah bekerja sebagai karyawan di bawah saya di perusahaan lain dan, sebagai hasilnya, mereka berdua diindoktrinasi dengan cara saya yang menurut pendapat melakukan sesuatu. Konsistensi yang ketat (di mana hal-hal, jelas, bisa) antara konfigurasi Pelanggan adalah anugerah. Jelas, produk berubah, jadi kami dapat mendiskusikan produk / versi baru, dll, dan memutuskan strategi konfigurasi yang konsisten sebelum kami gunakan. Ini tidak akan menskala ke perusahaan besar tetapi, terus terang, saya melihatnya sebagai fitur daripada bug. (Saya tidak akan mulai mengomel tentang perusahaan "layanan terkelola" yang lebih besar dengan "insinyur" karyawan mereka dan kecenderungan mengerikan untuk sekali pakai, "solusi" setengah-setengah, dan ketidakkonsistenan antara Pelanggan ...> tersenyum <)
Saya sangat menentang "pengikat yang ditakuti". Aku belum pernah melihat dokumentasi fisik terus up to date pernah . Saya pikir itu buang-buang uang Pelanggan untuk menghabiskan waktu membuat salinan fisik dokumentasi. Saya lebih suka menghabiskan waktu mencari cara menghasilkan dokumentasi berdasarkan data "langsung" dari menjalankan konfigurasi.
Sebagai contoh, saya sama sekali tidak akan memelihara spreadsheet dari informasi alamat IP. Itulah gunanya DHCP dan DNS (lihat di bawah untuk spesifik). Jika hal-hal itu tidak berhasil maka kita punya masalah besar.
Kami sudah meminta Pelanggan untuk melakukan hal-hal seperti "membuat dokumen yang menunjukkan semua konfigurasi Kebijakan Grup kami" dan saya sudah berusaha keras untuk menolaknya. Proposal balasan saya yang berulang (yang sejauh ini berhasil) adalah memperkenalkan Pelanggan pada alat administratif yang dapat memberi mereka "swalayan" atau menggunakan perangkat lunak untuk menghasilkan dokumentasi "langsung" sesuai permintaan pelanggan.
Kami berusaha sangat keras untuk menjadi teliti dalam mengeja hal-hal dalam bahasa Inggris. Kontak TI non-teknis dapat, misalnya, meninjau keanggotaan grup Direktori Aktif komputer dan melihat hal-hal seperti "Perangkat Lunak - Instal Microsoft Office 2010 Pro" dan "Kebijakan Grup - Kios Pengiriman Log Masuk Otomatis Komputer". Tidak perlu dokumentasi untuk menjelaskan apa arti semua itu.
Berikut beberapa data "langsung" yang kami gunakan:
Semua alokasi alamat IP disimpan di server DHCP - ini termasuk perangkat yang dialamatkan secara statis juga (dicatat seperti itu di komentar). Alamat MAC dan IP dapat dengan mudah ditanyakan oleh skrip atau secara manual dan, menurut definisi, data harus up-to-date jika digunakan dalam produksi.
Semuanya mendapat nama dan catatan PTR dalam DNS. Sebagian besar host juga mendapatkan catatan HINFO. Hal-hal yang membutuhkan deskripsi verbal mendapatkan catatan TXT.
Penggunaan bidang "Catatan" yang luas dan secara verbal sedapat mungkin - Direktori Aktif, deskripsi komputer, deskripsi folder bersama, dll. Kami juga menggunakan kata-kata seperti nama grup keamanan dengan kata-kata yang jelas dan jelas.
Komentar / komentar dalam konfigurasi gir jaringan (komentar pada ACL, deskripsi tentang port, lokasi SNMP / info kontak, misalnya).
Saya cukup negatif pada gagasan penyimpanan informasi bentuk bebas dalam hal-hal seperti file teks, wiki, dll. Struktur membuat pencarian yang baik. Setiap kali saya bisa mendapatkan mekanisme penyimpanan terstruktur untuk bekerja untuk saya (bahkan jika itu berarti saya harus menulis perangkat lunak untuk menanyakannya) saya lebih suka itu. Komentar yang saya dapat parse dari file konfigurasi, database, dll, selalu memenangkan saya ketika memasang terhadap dokumen yang dihasilkan secara manual yang akan segera keluar dari tanggal segera.
Ketika kita harus menyimpan informasi "bentuk bebas", kita menggunakan repositori SVN kita sendiri. Ini berisi semua bit dan potongan dokumentasi statis yang kami buat selama bertahun-tahun, diajukan oleh Pelanggan. Kami telah menggunakan SVN untuk ini sejak 2004 dan telah bekerja dengan baik sebagai alat kolaborasi bagi kami. Kami versi skema database, skrip sysadmin, cadangan objek Kebijakan Grup, dll. Saya mencoba memeriksa semua yang saya bisa ke kontrol versi.
Sangat mudah untuk mencari checkout saya dengan alat pengindeksan berbasis sistem file. Saya tahu bahwa masing-masing dari kita memiliki setidaknya satu salinan lengkap dari repositori yang tersedia bagi kita secara lokal kapan saja. Kami juga membuat repositori dapat diakses melalui WebDAV terotentikasi melalui SSL jika kami benar-benar harus mendapatkan data yang disimpan di sana dan hanya memiliki akses browser.
Kami tidak pernah diminta untuk melakukannya, tetapi kami akan dengan senang hati membuat akun di server SVN untuk memungkinkan Pelanggan melakukan check-out dan berinteraksi dengan file mereka sendiri (jika mereka memiliki sumber daya internal yang sangat condong ). Kami menggunakan format standar untuk menyimpan semua dokumentasi Pelanggan statis (dokumentasi lisensi perangkat lunak, catatan pembelian, dll) yang cukup jelas.
Bersamaan dengan repositori SVN, kami juga meng-host sendiri email kami. Semua email masuk / keluar telah diarsipkan sejak domain perusahaan mulai menerima email. Ini tersedia sebagai BSMTP log ke mitra untuk referensi (dan, secara pribadi, saya merasa itu sangat berharga). Situasinya tidak pernah muncul tetapi, saya tahu kami akan dengan senang hati memberikan akses kepada Pelanggan ke log korespondensi apa pun dengan / dari karyawan mereka jika mereka pernah bertanya. Mempersembahkan komunikasi internal antar mitra akan lebih sulit karena kami mungkin merujuk beberapa Pelanggan dalam pesan yang sama. (Kita mungkin seharusnya lebih baik tentang itu tetapi kita belum melakukannya.)
Kata sandi adalah "kutil" utama dalam proses kami. Kami menggunakan repositori "Password Safe" individual (dengan kombinasi unik) untuk setiap Pelanggan untuk memungkinkan file aman untuk dibagikan dengan Pelanggan. Kami menyimpan kata sandi utama untuk semua file aman di file aman lain, dengan kombinasi yang hanya diketahui oleh mitra. Bagian ini sangat membutuhkan pekerjaan. Saya pikir kami ingin setiap pelanggan meng-host vault kredensial di tempat menggunakan aplikasi kubah kata sandi multi-pengguna yang nyata (dengan jejak audit, dll.) Tetapi kami telah menendang gagasan itu ke pantai selama hampir 10 tahun sekarang .
Catatan pelacakan waktu kami dirinci dengan cermat dan diberikan kepada Pelanggan dalam format elektronik apa pun yang mereka inginkan (yang, hingga saat ini, adalah teks ASCII dan PDF). Pelanggan mendapatkan waktu mulai / berhenti pada setiap acara yang dapat ditagih, dan deskripsi kerja yang dilakukan secara verbal. Kami menganggap catatan layanan ini sangat berharga secara internal karena mereka memungkinkan kami untuk tetap mengikuti apa yang terjadi di situs Pelanggan mitra. Jika ada masalah, catatan ini memberi kami pengetahuan berdasarkan semua masalah dan resolusi sebelumnya yang kami temui selama bertahun-tahun. Saya tidak malu mengatakan bahwa saya telah menyelesaikan masalah untuk satu Pelanggan dengan menemukan catatan yang saya lupa tulis untuk Pelanggan lain bertahun-tahun sebelumnya.
Samping cepat dan peringatan: memproduksi dokumentasi: Pada "pekerjaan lama" saya (bekerja untuk orang lain bertahun-tahun yang lalu) perusahaan melakukan tindakan hukum terhadap Pelanggan yang tidak membayar. Kami akhirnya berada di ujung bisnis gugatan dari Pelanggan yang tidak membayar. Catatan internal dan email kami kembali: bahwa Pelanggan dipanggil dan ditelanjangi di depan pengadilan. Pengalaman itu mengajari saya banyak hal tentang tidak menyimpan apa pun dalam media tetap yang Anda tidak ingin dipublikasikan.
Saya telah menulis beberapa email dengan kata-kata dan frasa pilihan (erm) di dalamnya tentang frustrasi saya dengan Pelanggan ini dan dengan beberapa "insinyur" lain di perusahaan saya. Harus diperiksa silang tentang hal-hal ini di pengadilan terbuka bukanlah sesuatu yang saya nikmati sama sekali.
Ketika kami memulai bisnis kami saat ini, para mitra sepakat bahwa semua catatan tetap (email, pesan teks, voicemail, file dalam repositori SVN, catatan kerja dalam pelacak waktu, dll) akan dianggap "Menghadapi Pelanggan" sepanjang waktu - bahkan jika mereka tidak pernah dimaksudkan untuk berakhir di tangan Pelanggan. Ini sulit dilakukan dan membutuhkan banyak disiplin tetapi saya pikir itu sepadan. Kami tentu ingin memproyeksikan suasana profesionalisme kepada Pelanggan kami, dan menjalaninya adalah cara untuk melakukannya. Saya pasti tidak akan pernah malu seperti berada di ruang sidang itu lagi.