Perusahaan IT rata-rata ngagaduhan syarat, sajarah pelacak tugas, sumber (sugan sareng koméntar dina kodeu), paréntah pikeun kasus anu khas, penting sareng rumit dina produksi, pedaran prosés bisnis (tina onboarding ka "kumaha nuju liburan. ”), kontak, konci aksés, daptar jalma sareng proyék, déskripsi ngeunaan daérah tanggung jawab - sareng sakumpulan pangaweruh sanés anu sigana urang hilap sareng anu tiasa disimpen di tempat anu paling endah.
Pangaweruh =/= dokuméntasi. Ieu teu bisa dijelaskeun, éta kudu inget
Kumaha pikeun mastikeun yén jalma anu peryogi kauninga tina hal ieu ngartos dimana jeung kumaha carana manggihan eta, sarta saha wae anu kudu sadar hal individu jeung pasatujuan bisa langsung tur akurat manggihan ngeunaan parobahanana.
Dina episode ahir podcast "Team Lead Will Call", guys ti Skyeng ngobrolkeun ngeunaan manajemén pangaweruh sareng Igor. Tsupko mangrupikeun jalma dina panitia program KnowledgeConf sareng "direktur anu teu dipikanyaho" di Flant.
Rekaman pinuh sadia sakumaha , sareng di handap ieu kami parantos ngumpulkeun sababaraha tip anu pikaresepeun sareng tautan kana bahan anu mangpaat anu disebatkeun dina audio atanapi dilegakeun inpormasi ti dinya. Éta langkung saé upami anjeun ogé ngabagi hacks sareng trik tim anjeun dina koméntar.
Hack munggaran: anjeun henteu peryogi deui terang sistem mana anu kedah ditingali
"Kuring nyandak sumber pangaweruh urang sareng milarian umum pikeun aranjeunna: jandela tunggal sareng sistem panyaring pikeun ngirangan daérah pamilarian. Leres, dina waktos anu sami, anjeun masih kedah ngawas kualitasna, ngeusian pangkalan pangaweruh, sareng ngempur duplikasi sareng inpormasi anu salah.
Hiji salembar kertas pikeun manggihan éta sakabéh
Tapi geus, ngeunaan 60% insinyur Flant ngagunakeun pilarian ieu sahenteuna 1-2 kali sapoé - sarta biasana manggihan jawaban dina posisi kahiji atawa kadua. Sareng dina bentuk bukti konsép nyaéta indexing tina dokumén Google: sadaya doxs, folder, van drive, jeung saterusna - kabeh ieu ogé gampang disetir kana pilarian internal.
Hack kadua: kumaha teu sono hal kritis penting dina kebat obrolan
"Upami anjeun damel di tim anu disebarkeun, maka sigana bagian anu penting dina dinten anjeun diséépkeun di Slack - sareng dina hal ieu anjeun biasa ngalakukeun sapertos kieu: "@myteam, bantosan / tingali / lebetkeun anu leres ... "." Tapi aya masalah sareng seueur inpormasi - sareng penyebutan anu misah tiasa dileungitkeun diantara pesen anu sanés.
Di Skyeng kami dibantuan ku bot dimana anjeun tiasa nyerat pesen sareng tag sajumlah jalma atanapi grup. Kami nganggo éta dina kasus anu penting pisan yén jalma maca atanapi ngaréaksikeun: éta bakal nyodok sajajalan dugi ka anjeun pencét tombol "Kuring maca" - anjeun moal tiasa ngalangkungan atanapi teu malire.
Patarosan pikeun ngajawab: naon anu kudu dipigawé kalayan dokuméntasi?
"Seueur pangaweruh asalna tina téknologi, tapi henteu sadayana terang kumaha ngajelaskeun éta.
Barina ogé, anjeun henteu gaduh kompiler atanapi linter anu tiasa nyarioskeun ka anjeun naha anjeun leres atanapi henteu - sareng sering kaluaran anu kami pikahoyong, henteu diformat sareng téks anu teu lengkep. Tangtosna, anjeun kedah ngalakukeun éta sacara normal, sanés kusabab aya anu sumping sareng nyarios "peryogi" - anjeun ngalakukeunana saé pikeun diri anjeun: dina sabulan atanapi dua anjeun bakal maca sareng ngartos. Jeung jalma sejen, muka dokumen a, moal langsung nutup eta salawasna, nyadar yén éta téh aya gunana.
Bagian tina podcast khusus pikeun patarosan "Sabaraha jalma anu diperyogikeun pikeun nyerat dokuméntasi anu saé atanapi ngadamel demo normal"
Tapi patarosan tetep: sabaraha waktos alokasi pikeun ieu sareng kumaha carana ngalakukeun éta éfisién?
Tur upami aya hiji jawaban jujur dieu: iwal jalma bisnis aub, na iwal aranjeunna émpiris ngalaman dampak dokuméntasi alus, aya resiko nu usaha bakal ngahasilkeun saeutik mulang. Ieu langkung seueur carita ngeunaan ngarobih budaya.
Pikeun sésana, pangalaman sareng bimbingan bakal nyalametkeun anjeun. Analog tina program pasangan, pelacak kamajuan sareng ulasan kode tiasa cocog di dieu - nunjukkeun prakték anu pangsaéna, nyodok kasalahan sareng ngabosenkeun tungtungna.
Bonus: "Oke, kuring bakal nyarioskeun ka aranjeunna, aranjeunna bakal ngartos"
Patarosan "sabaraha waktos méakkeun on ieu sareng di tingkat naon ngalakukeun hal eta" penting teu ukur dina kerangka dokuméntasi, tapi sacara umum pikeun mindahkeun pangaweruh nanaon. Demo ogé mangrupikeun conto anu saé pikeun ngabagi inpormasi. Tapi aya nuances: contona, kumaha carana mastikeun yén maranéhna butuh waktu minimal.
Saluran babagi pangaweruh diantara pamekaran: laporan internal, buku mangpaat, artikel, jsb. Ekstrak terstruktur ogé disimpen dina Notion.
Sabagéan, masalah ieu tiasa direngsekeun ku prakték laporan internal. Saminggu sakali, 40-60 menit dicandak dina waktos anu kirang sibuk - sareng budak lalaki ngadamel laporan pidéo pikeun kolega ti proyék anu béda. Tim frontend sahiji produk konci - Vimbox - ngeunaan kit UI Anjeun, nu bisa themed pikeun sagala proyék séjén. Tim pamekaran pamasaran nyarioskeun ngeunaan perpustakaan pikeun nyukcruk sareng logging pamundut, anu langsung narik minat sababaraha proyék sanés. Tim proyék Matematika ngabagi pangalamanana pikeun ngalih ti REST API ka GraphQL. Tim palajaran grup ieu pamikiran babagi kumaha maranéhanana kahiji pindah ka PHP 7.4. Teras salajengna.
Daptar éta parantos dijaga saprak Méi 2018 sareng ngagaduhan langkung ti 120 éntri
Sadaya rapat dimimitian ku Google Meet perusahaan, dirékam sareng dina 1.5 jam némbongan dina polder dina drive Google anu dibagikeun, sareng tautan kana rekaman diduplikasi dina Slack anu sami. Hartina, anjeun teu kudu datang lamun aya kaayaan darurat, tapi lalajo eta engké di 20 speed - biasana laporan sorangan lasts nepi ka XNUMX menit, sarta diskusi - kumaha tétéla. Tapi urang henteu langkung ti sajam)
PS Naon anu dianggo sareng henteu dianggo pikeun anjeun?
Tumbu mangpaat:
- Rodion Nagornov ti Kaspersky Lab ngeunaan sareng naha ieu sanés dokuméntasi (hatur nuhun kana saluran Igor pikeun tautan , aya seueur deui anu sapertos kitu).
- Igor Tsupko ti Flant ngeunaan éta di parusahaan kuring
- Alexey Kataev ti Skyeng (kesenjangan pangaweruh dina téknologi sareng daérah khusus) dina tim anu disebarkeun.
- Sergey Goncharuk ti Flant ngeunaan nepikeun inpormasi - , lamun sapatemon masalah dina tim disebarkeun.
sumber: www.habr.com