Perusahaan IT rata-rata duwe syarat, riwayat pelacak tugas, sumber (bisa uga ana komentar ing kode), instruksi kanggo kasus sing khas, penting lan rumit ing produksi, deskripsi proses bisnis (saka onboarding nganti "carane liburan β), kontak, tombol akses, dhaptar wong lan proyek, deskripsi wilayah tanggung jawab - lan akeh kawruh liyane sing bisa uga kita kelalen lan bisa disimpen ing papan sing paling apik tenan.
Kawruh =/= dokumentasi. Iki ora bisa diterangake, kudu dieling-eling
Cara kanggo mesthekake yen wong-wong sing kudu ngerti soko saka iki ngerti ngendi lan carane nemokake iku, lan saben wong sing kudu weruh bab individu lan persetujuan bisa langsung lan kanthi cepet ngerti bab owah-owahan ing wong.
Ing episode pungkasan podcast "Team Lead Will Call", wong lanang saka Skyeng ngomong babagan manajemen pengetahuan karo Igor. Tsupko minangka wong ing panitia program KnowledgeConf lan "direktur sing ora dingerteni" ing Flaunt.
Rekaman lengkap kasedhiya minangka , lan ing ngisor iki kita wis ngumpulake sawetara tips menarik lan pranala menyang bahan migunani sing kasebut ing audio utawa ngembangaken informasi saka iku. Iku bakal apik yen sampeyan uga nuduhake hacks lan trik tim ing komentar.
Hack pisanan: sampeyan ora perlu maneh ngerti kang sistem kanggo katon ing
"Aku njupuk sumber kawruh kita lan nggawe panelusuran umum kanggo wong-wong mau: jendhela siji karo sistem nyaring kanggo ngurangi area panelusuran. Ya, ing wektu sing padha, sampeyan isih kudu ngawasi kualitase, ngisi basis pengetahuan, lan nglawan duplikasi lan informasi sing salah.
Siji kertas kanggo nemokake iku kabeh
Nanging saiki, kira-kira 60% insinyur Flant nggunakake telusuran iki paling ora 1-2 kaping dina - lan biasane nemokake jawaban ing posisi pisanan utawa kaloro. Lan ing wangun bukti konsep yaiku ngindeks dokumen Google: kabeh dox, folder, drive van, lan liya-liyane - kabeh iki uga gampang didorong menyang telusuran internal.
Hack kapindho: carane ora kantun bab kritis penting ing Bunch saka chats
"Yen sampeyan kerja ing tim sing disebarake, mula bisa uga ana bagean penting ing dina sampeyan ing Slack - lan yen sampeyan wis biasa nindakake kaya iki: "@myteam, tulung / deleng / ketik sing bener ... β.β Nanging ana masalah karo turah mbrawah saka informasi - lan sebutno kapisah bisa ora kejawab antarane pesen liyane.
Ing Skyeng, kita dibantu dening bot sing bisa digunakake kanggo nulis pesen lan menehi tag sawetara wong utawa klompok. Iki digunakake ing kasus sing penting banget yen wong maca utawa nanggepi: bakal terus-terusan nganti sampeyan menet tombol "Aku maca" - sampeyan ora bakal bisa ngliwati utawa nglirwakake.
Pitakonan kanggo mangsuli: apa sing kudu dilakoni karo dokumentasi?
"Akeh kawruh teka saka teknisi, nanging ora kabeh wong ngerti carane njlentrehake kanthi apik.
Sawise kabeh, sampeyan ora duwe compiler utawa linter sing bakal menehi pitutur marang kowe apa sampeyan nindakake kanthi bener utawa ora - lan asring output sing kita duwe ora bisa dingerteni, format sing kurang apik lan teks sing ora lengkap. Mesthi wae, sampeyan kudu nindakake kanthi normal, ora amarga ana wong sing teka lan ujar "perlu" - sampeyan nindakake kanthi becik: ing sasi utawa rong wulan sampeyan bakal maca lan ngerti. Lan wong liya, mbukak dokumen, ora bakal langsung nutup ing salawas-lawase, nyadari yen ora ana gunane.
BagΓ©yan saka podcast khusus kanggo pitakonan "Pinten wong sing kudu nulis dokumentasi sing apik utawa nggawe demo normal"
Nanging pitakonan tetep: pinten wektu kanggo nyedhiyakake iki lan carane nindakake kanthi efisien?
Lan yen ana jawaban jujur ββkene: kajaba wong bisnis melu, lan kajaba padha empiris nemu impact saka dokumentasi apik, ana resiko sing gaweyan bakal ngasilake sethitik bali. Iki luwih crita babagan owah-owahan budaya.
Kanggo liyane, pengalaman lan bimbingan bakal nylametake sampeyan. Analog saka program pasangan, pelacakan kemajuan lan review kode bisa uga cocog ing kene - nuduhake praktik paling apik, kesalahan lan mboseni ing pungkasan.
Bonus: "Oke, aku bakal ngandhani dheweke kanthi cara iki, dheweke bakal ngerti"
Pitakonan "pira wektu kanggo nglampahi iki lan ing tingkat apa" iku penting ora mung ing framework saka dokumentasi, nanging ing umum kanggo transfer kawruh sembarang. Demo uga minangka conto sing apik kanggo nuduhake informasi. Nanging ana nuansa: contone, carane nggawe manawa njupuk wektu minimal.
Saluran enggo bareng kawruh antarane pembangunan: laporan internal, buku migunani, artikel, etc. Ekstrak terstruktur uga disimpen ing Notion.
Sebagean, masalah kasebut bisa ditanggulangi kanthi praktik laporan internal. Sawise seminggu, 40-60 menit ditindakake ing wektu sing kurang sibuk - lan wong lanang nggawe laporan video kanggo kolega saka macem-macem proyek. Tim ngarep produk utama - Vimbox - babagan kit UI sampeyan, sing bisa dadi tema kanggo proyek liyane. Tim pangembangan marketing ngomong babagan perpustakaan kanggo nelusuri lan logging panjalukan, sing langsung narik minat sawetara proyek liyane. Tim proyek Matematika nuduhake pengalaman ngoper saka REST API menyang GraphQL. Tim pawulangan klompok mikir babagan carane dheweke dadi wong pisanan sing ngalih menyang PHP 7.4. Lan sateruse.
Π‘ΠΏΠΈΡΠΎΠΊ Π²Π΅Π΄Π΅ΡΡΡ Ρ ΠΌΠ°Ρ 2018-Π³ΠΎ ΠΈ Π½Π°ΡΡΠΈΡΡΠ²Π°Π΅Ρ ΡΠ²ΡΡΠ΅ 120 Π·Π°ΠΏΠΈΡΠ΅ΠΉ
Kabeh rapat diwiwiti liwat Google Meet perusahaan, direkam lan ing 1.5 jam katon ing folder ing drive Google sing dienggo bareng, lan pranala menyang rekaman diduplikasi ing Slack sing padha. Yaiku, sampeyan ora kudu teka yen ana darurat, nanging nonton mengko ing kacepetan 20 - biasane laporan dhewe nganti XNUMX menit, lan diskusi - kepiye kedadeyan. Nanging kita ora ngluwihi jam)
PS Apa sing makarya lan ora bisa kanggo sampeyan?
Link migunani:
- Rodion Nagornov saka Kaspersky Lab babagan lan kenapa iki dudu dokumentasi (matur nuwun kanggo saluran Igor kanggo link kasebut , isih akeh sing kaya ngono).
- Igor Tsupko saka Flant babagan iki ing perusahaanku
- Alexey Kataev saka Skyeng (kesenjangan kawruh ing teknologi lan wilayah tartamtu) ing tim sing disebarake.
- Sergey Goncharuk saka Flant babagan ngirim informasi - , yen sampeyan nemoni masalah ing tim sing disebarake.
Source: www.habr.com