It gemiddelde IT-bedriuw hat easken, in skiednis fan taak trackers, boarnen (miskien sels mei opmerkings yn 'e koade), ynstruksjes foar typyske, wichtige en komplekse gefallen yn produksje, in beskriuwing fan saaklike prosessen (fan onboarding oant "hoe op fakânsje gean ”), kontakten, tagongskaaien, listen mei minsken en projekten, beskriuwingen fan ferantwurdlikensgebieten - en in boskje oare kennis dy't wy wierskynlik fergetten binne en dy't op 'e meast geweldige plakken kinne wurde opslein.
Kennis =/= dokumintaasje. Dit kin net ferklearre wurde, it moat betocht wurde
Hoe kinne jo derfoar soargje dat dejinge dy't hjir wat fan witte moat, begrypt wêr't en hoe't it te finen is, en elkenien dy't bewust wêze moat fan yndividuele dingen en ôfspraken, kin daliks en sekuer op 'e hichte komme oer feroarings dêryn.
Yn 'e lêste ôflevering fan' e "Team Lead Will Call" podcast, prate de jonges fan Skyeng oer kennisbehear mei Igor Tsupko is in persoan yn de KnowledgeConf-programmakommisje en de "direkteur fan it ûnbekende" by Flant.
De folsleine opname is beskikber as , en hjirûnder wy hawwe sammele wat nijsgjirrige tips en keppelings nei brûkbere materialen dy't waarden neamd yn de audio of útwreidzje op de ynformaasje fan it. It soe geweldich wêze as jo ek de hacks en trúkjes fan jo team diele yn 'e kommentaren.
Earste hack: jo hoege net mear te witten yn hokker systeem jo moatte sjen
“Ik naam ús kennisboarnen en makke in algemiene syktocht nei se: ien finster mei in filtersysteem om it sykgebiet te ferminderjen. Ja, tagelyk moatte jo de kwaliteit noch kontrolearje, de kennisbasis oanfolje, en duplikaasje en ferkearde ynformaasje bestride.
Ien stikje papier te finen dat is alles
Mar al brûkt sa'n 60% fan Flant-yngenieurs dizze sykopdracht op syn minst 1-2 kear deis - en fynt normaal antwurden yn 'e earste of twadde posysjes. En yn 'e foarm fan proof of concept is it yndeksearjen fan Google-dokuminten: alle doxen, mappen, bestelauto's, ensfh.
Twadde hack: hoe net te missen kritysk wichtige dingen yn in boskje petearen
"As jo wurkje yn in ferspraat team, dan wurdt wierskynlik in signifikant diel fan jo dei yn Slack trochbrocht - en yn dat gefal binne jo wend om sa'n ding te dwaan: "@myteam, help / sjoch / fier de juste yn ... "." Mar d'r is in probleem mei de oerfloed fan ynformaasje - en in aparte fermelding kin mist wurde ûnder oare berjochten.
By Skyeng wurde wy holpen troch in bot wêrmei jo in berjocht skriuwe kinne en elk oantal minsken of groepen taggje kinne. Wy brûke it yn gefallen wêr't it echt wichtich is dat minsken lêze of reagearje: it sil einleaze poke oant jo op de knop "Ik lês" drukke - jo kinne it net oerslaan of negearje."
Fraach om te beantwurdzjen: wat te dwaan mei de dokumintaasje?
“In protte kennis komt fan technyk, mar net elkenien wit it goed te beskriuwen.
Jo hawwe ommers gjin kompilator of linter dy't jo soe fertelle oft jo it goed dogge of net - en faaks is de útfier dy't wy hawwe ûnbegryplik, min opmakke en ûnfolsleine tekst. Fansels moatte jo it normaal dwaan, net om't immen kaam en sei "it is nedich" - jo dogge it goed foar josels: oer in moanne of twa sille jo it lêze en begripe. En in oare persoan, it iepenjen fan in dokumint, sil it net fuortendaliks slute foar altyd, realisearje dat it nutteloos is.
In diel fan 'e podcast wijd oan' e fraach "Hoeveel minsken hat it nedich om goede dokumintaasje te skriuwen of in normale demo te meitsjen"
Mar de fraach bliuwt: hoefolle tiid te besteegjen foar dit en hoe te dwaan it effisjint?
En as der hjir in earlik antwurd is: útsein as der saaklike minsken by belutsen binne, en as se net empirysk de ynfloed fan goede dokumintaasje ûnderfine, is der it risiko dat de ynset net folle opbringst. Dit is mear in ferhaal oer feroarjende kultuer.
Foar de rest sille ûnderfining en mentoring jo rêde. Analogen fan programmearring foar pearen, folgjen fan foarútgong en beoardielingen fan koade kinne hjir geskikt wêze - bêste praktiken sjen litte, flaters sykje en op it lêst saai.
Bonus: "Okee, ik sil har dizze manier fertelle, se sille it begripe"
De fraach "hoefolle tiid te besteegjen oan dit en op hokker nivo te dwaan it" is wichtich net allinnich yn it ramt fan dokumintaasje, mar yn it algemien foar de oerdracht fan alle kennis. De demo is ek in geweldich foarbyld fan it dielen fan ynformaasje. Mar der binne nuânses: bygelyks, hoe te soargjen dat se nimme minimale tiid.
Kanaal foar dielen fan kennis ûnder ûntwikkeling: ynterne rapporten, nuttige boeken, artikels, ensfh. It strukturearre úttreksel wurdt ek opslein yn Notion.
Foar in part kinne dizze problemen oplost wurde troch de praktyk fan ynterne rapporten. Ien kear yn 'e wike wurde 40-60 minuten nommen op in minder drokke tiid - en de jonges meitsje in fideoferslach foar kollega's fan ferskate projekten. Frontend team fan it kaaiprodukt - Vimbox - oer jo UI-kit, dat kin wurde tematyk foar elk oar projekt. It marketingûntwikkelingsteam spruts oer in biblioteek foar tracing en logging fan oanfragen, dy't fuortendaliks de belangstelling fan ferskate oare projekten luts. It Mathematics-projektteam dielde har ûnderfining fan it wikseljen fan REST API nei GraphQL. It groepslessteam tinkt oan te dielen hoe't se de earsten wiene dy't oerstapten nei PHP 7.4. Ensafuorthinne.
De list is sûnt maaie 2018 byhâlden en hat mear dan 120 ynstjoerings
Alle gearkomsten wurde begon fia Google Meet bedriuw, opnommen en binnen 1.5 oeren ferskine yn in map op in dielde Google-drive, en keppelings nei de opnames wurde duplikearre yn deselde Slack. Dat is, jo hoege net te kommen as der in need is, mar sjoch it letter op 20 snelheid - meastentiids duorret it rapport sels oant XNUMX minuten, en de diskusje - hoe't it útkomt. Mar wy geane net fierder as de oere)
PS Wat wurke en wurke net foar jo?
Nuttige links:
- Rodion Nagornov út Kaspersky Lab oer en wêrom dit gjin dokumintaasje is (mei tank oan Igor's kanaal foar de keppeling , d'r is in protte mear as dat).
- Igor Tsupko fan Flant dêroer yn myn bedriuw
- Alexey Kataev út Skyeng (kennisgaten yn technologyen en spesifike gebieten) yn in ferspraat team.
- Sergey Goncharuk fan Flant oer it oerbringe fan ynformaasje - , as jo in probleem tsjinkomme yn in ferdield team.
Boarne: www.habr.com