Prosječna IT kompanija ima zahtjeve, historiju zadataka za praćenje, izvorne kodove (možda čak i sa komentarima u kodu), upute za tipične, važne i složene slučajeve u proizvodnji, opis poslovnih procesa (od onboardinga do „kako otići na odmor“), kontakte, pristupne ključeve, spiskove ljudi i projekata, opis područja odgovornosti – i gomilu drugih znanja o kojima se najvjerovatnije možemo pohraniti na mjesta i koja vjerovatno možemo zaboraviti.

Znanje =/= dokumentacija. Ovo se ne može objasniti, mora se zapamtiti
Kako se pobrinuti da oni koji trebaju nešto iz ovoga da znaju gdje i kako to mogu pronaći, a svi koji trebaju biti svjesni pojedinačnih stvari i dogovora mogu trenutno i tačno saznati o promjenama u njima.
U poslednjoj epizodi podcasta “Team Lead Will Call”, momci iz Skyeng razgovarali su o upravljanju znanjem sa Igorom Tsupko je osoba u programskom komitetu KnowledgeConf i „direktor nepoznatog“ u Flantu.
Kompletan snimak je dostupan kao , a u nastavku smo prikupili nekoliko zanimljivih savjeta i linkova na korisne materijale koji su spomenuti u audio snimku ili proširuju informacije iz njega. Bilo bi sjajno da u komentarima podijelite i trikove i trikove svog tima.
Prvi hak: više ne morate znati koji sistem da tražite
"Uzeo sam naše izvore znanja i izvršio opštu pretragu na njima: jedan prozor sa sistemom filtriranja za smanjenje područja pretraživanja. Da, ali i dalje morate pratiti njegov kvalitet, dopunjavati bazu znanja, boriti se protiv dupliranja i pogrešnih informacija."

Jedan komad papira da nađete to je sve
Ali već, oko 60% Flant inženjera koristi ovu pretragu barem 1-2 puta dnevno - i obično pronađu odgovore na prvoj ili drugoj poziciji. A u obliku dokaza koncepta je indeksiranje Google dokumenata: svih dokumenata, foldera, kombi pogona i tako dalje – sve se to također lako ubacuje u internu pretragu.”
Drugi hak: kako ne propustiti kritično važne stvari u gomili ćaskanja
“Ako radite u raspoređenom timu, onda vjerovatno značajan dio vašeg dana provodite u Slacku – a ako se nešto dogodi, navikli ste da radite nešto ovako: “@myteam, pomozi/pogledaj/unesi pravu...” Ali postoji problem s obiljem informacija – a posebno spominjanje može izostati među ostalim porukama.

U Skyengu nam pomaže bot preko kojeg možete napisati poruku i označiti bilo koji broj ljudi ili grupa. Koristimo ga u slučajevima kada je zaista važno da ljudi čitaju ili reaguju: bockaće se beskrajno dok ne pritisnete dugme „Čitam“ – nećete ga moći preskočiti ili ignorisati.”
Pitanje na koje treba odgovoriti: šta učiniti sa dokumentacijom?
„Mnogo znanja dolazi od tehničara, ali ne znaju svi kako to dobro opisati.
Na kraju krajeva, nemate nikakav kompajler ili linter koji bi vam rekao da li to radite kako treba ili ne - a često je izlaz koji imamo nerazumljiv, loše formatiran i nekompletan tekst. Naravno, to treba da uradite normalno, a ne zato što je neko došao i rekao "potrebno je" - uradite to dobro za sebe: za mesec-dva ćete to pročitati i razumeti. A druga osoba, otvarajući dokument, neće ga odmah zauvijek zatvoriti, shvaćajući da je beskoristan.

Dio podcasta posvećenog pitanju "Koliko je ljudi potrebno da se napiše dobra dokumentacija ili napravi normalan demo"
Ali ostaje pitanje: koliko vremena izdvojiti za to i kako to učiniti efikasno?
A ako ovdje postoji iskren odgovor: osim ako poslovni ljudi nisu uključeni, i ako empirijski ne iskuse utjecaj dobre dokumentacije, postoji rizik da će trud dati malo povrata. Ovo je više priča o promeni kulture.
U ostalom, iskustvo i mentorstvo će vas spasiti. Ovdje bi mogli biti prikladni analozi programiranja u paru, praćenja napretka i pregleda koda – pokazivanje najboljih praksi, bockanje po greškama i dosadno na kraju.”
Bonus: "U redu, reći ću im ovako, razumjet će"
Pitanje „koliko vremena potrošiti na to i na kom nivou to učiniti“ važno je ne samo u okviru dokumentacije, već općenito za prijenos bilo kojeg znanja. Demo je također odličan primjer dijeljenja informacija. Ali postoje nijanse: na primjer, kako se pobrinuti da oduzimaju minimalno vrijeme.

Kanal razmjene znanja među razvojnim programima: interni izvještaji, korisne knjige, članci, itd. Strukturirani izvod je također pohranjen u Notion.
Djelomično se ovi problemi mogu riješiti praksom internih izvještaja. Jednom sedmično se odvoji 40-60 minuta u manje prometno vrijeme - i momci prave video izvještaj za kolege iz različitih projekata. Frontend tim ključnog proizvoda - Vimbox - o vašem UI kompletu, koji može biti tematski za bilo koji drugi projekat. Tim za razvoj marketinga govorio je o biblioteci za praćenje i evidentiranje zahtjeva, što je odmah privuklo interesovanje nekoliko drugih projekata. Tim projekta Matematika podijelio je svoje iskustvo prelaska sa REST API-ja na GraphQL. Tim za grupne lekcije razmišlja o tome da podijeli kako su prvi prešli na PHP 7.4. I tako dalje.
Lista se održava od maja 2018. godine i ima preko 120 unosa
Svi sastanci se pokreću preko korporativnog Google Meeta, snimaju i u roku od 1.5 sata pojavljuju se u folderu na zajedničkom Google disku, a veze do snimaka se dupliraju u istom Slacku. Odnosno, ne morate dolaziti ako je hitan slučaj, već ga pogledajte kasnije na 20 brzine - obično sam izvještaj traje do XNUMX minuta, a rasprava - kako ispadne. Ali ne idemo dalje od sata)
PS Šta vam je uspjelo, a šta nije?
Korisni linkovi:
- Rodion Nagornov iz Kaspersky Lab o i zašto ovo nije dokumentacija (hvala Igorovom kanalu na linku , ima još mnogo toga).
- Igor Tsupko iz Flanta o tome u mom društvu
- Alexey Kataev iz Skyenga (praznine u znanju u tehnologijama i specifičnim oblastima) u distribuiranom timu.
- Sergej Gončaruk iz Flanta o prenošenju informacija - , ako naiđete na problem u distribuiranom timu.
izvor: www.habr.com
