Das durchschnittliche IT-Unternehmen verfügt über Anforderungen, eine Historie von Task-Trackern, Quellen (vielleicht sogar mit Kommentaren im Code), Anleitungen für typische, wichtige und komplexe Fälle in der Produktion, eine Beschreibung von Geschäftsprozessen (vom Onboarding bis „wie man in den Urlaub fährt“) “), Kontakte, Zugangsschlüssel, Listen von Personen und Projekten, Beschreibungen von Verantwortungsbereichen – und eine Menge anderes Wissen, das wir wahrscheinlich vergessen haben und das an den erstaunlichsten Orten gespeichert werden kann.
Wissen =/= Dokumentation. Das lässt sich nicht erklären, man muss sich daran erinnern
So stellen Sie sicher, dass diejenigen, die etwas daraus wissen müssen, verstehen, wo und wie sie es finden können, und dass jeder, der sich über einzelne Dinge und Vereinbarungen im Klaren sein muss, sofort und genau über deren Änderungen informiert werden kann.
In der letzten Folge des „Team Lead Will Call“-Podcasts sprachen die Jungs von Skyeng mit Igor über Wissensmanagement Tsupko ist Mitglied des KnowledgeConf-Programmkomitees und der „Direktor des Unbekannten“ bei Flant.
Die vollständige Aufzeichnung ist verfügbar als , und unten haben wir einige interessante Tipps und Links zu nützlichen Materialien zusammengestellt, die im Audio erwähnt wurden oder die Informationen daraus erweitern. Es wäre großartig, wenn Sie auch die Hacks und Tricks Ihres Teams in den Kommentaren teilen würden.
Erster Trick: Sie müssen nicht mehr wissen, in welchem System Sie suchen müssen
„Ich habe unsere Wissensquellen genommen und eine allgemeine Suche danach durchgeführt: ein einzelnes Fenster mit einem Filtersystem, um den Suchbereich zu reduzieren. Ja, gleichzeitig müssen Sie weiterhin die Qualität überwachen, die Wissensdatenbank auffüllen und Doppelarbeit und fehlerhafte Informationen bekämpfen.
Ein Blatt Papier, um das zu finden, ist alles
Aber schon jetzt nutzen etwa 60 % der Flant-Ingenieure diese Suche mindestens 1-2 Mal am Tag – und finden Antworten meist an erster oder zweiter Stelle. Und in Form eines Proof of Concept erfolgt die Indizierung von Google-Dokumenten: alle Doxs, Ordner, Van-Laufwerke usw. – all dies lässt sich auch problemlos in die interne Suche einfließen lassen.“
Zweiter Hack: Wie man in vielen Chats keine wichtigen Dinge verpasst
„Wenn Sie in einem verteilten Team arbeiten, verbringen Sie wahrscheinlich einen erheblichen Teil Ihres Tages in Slack – und in diesem Fall sind Sie es gewohnt, so etwas zu tun: „@myteam, helfen/suchen/geben Sie das Richtige ein...“ ”.” Allerdings gibt es ein Problem mit der Fülle an Informationen – und eine gesonderte Erwähnung unter anderen Nachrichten kann untergehen.
Bei Skyeng hilft uns ein Bot, über den Sie eine Nachricht schreiben und beliebig viele Personen oder Gruppen markieren können. Wir verwenden es in Fällen, in denen es wirklich wichtig ist, dass die Leute lesen oder reagieren: Es wird endlos gestochen, bis Sie auf die Schaltfläche „Ich lese“ klicken – Sie können es nicht überspringen oder ignorieren.“
Zu beantwortende Frage: Was tun mit der Dokumentation?
„Viel Wissen kommt von Technikfreaks, aber nicht jeder weiß, wie man es gut beschreibt.
Schließlich haben Sie keinen Compiler oder Linter, der Ihnen sagt, ob Sie es richtig machen oder nicht – und oft ist die Ausgabe, die wir haben, unverständlicher, schlecht formatierter und unvollständiger Text. Natürlich müssen Sie es normal machen, nicht weil jemand gekommen ist und gesagt hat: „Es ist notwendig“ – Sie machen es gut für sich selbst: In ein oder zwei Monaten werden Sie es lesen und verstehen. Und eine andere Person, die ein Dokument öffnet, wird es nicht sofort für immer schließen, weil sie erkennt, dass es nutzlos ist.
Teil des Podcasts, der der Frage gewidmet ist: „Wie viele Leute braucht man, um eine gute Dokumentation zu schreiben oder eine normale Demo zu machen?“
Es bleibt jedoch die Frage: Wie viel Zeit sollte man dafür einplanen und wie kann man es effizient erledigen?
Und wenn es hier eine ehrliche Antwort gibt: Wenn Geschäftsleute nicht einbezogen werden und die Auswirkungen einer guten Dokumentation nicht empirisch erfahren, besteht die Gefahr, dass der Aufwand wenig Ertrag bringt. Dies ist eher eine Geschichte über den Wandel der Kultur.
Im Übrigen werden Sie durch Erfahrung und Mentoring gerettet. Analoge zu Paarprogrammierung, Fortschrittsverfolgung und Codeüberprüfungen können hier geeignet sein – Best Practices zeigen, Fehler ansprechen und am Ende langweilig sein.“
Bonus: „Okay, ich sage es ihnen so, sie werden es verstehen.“
Die Frage „wie viel Zeit muss man dafür aufwenden und auf welcher Ebene soll man es machen?“ ist nicht nur im Rahmen der Dokumentation, sondern generell für die Wissensvermittlung wichtig. Die Demo ist auch ein großartiges Beispiel für den Informationsaustausch. Aber es gibt Nuancen: zum Beispiel, wie man dafür sorgt, dass sie möglichst wenig Zeit in Anspruch nehmen.
Kanal zum Wissensaustausch zwischen der Entwicklung: interne Berichte, nützliche Bücher, Artikel usw. Der strukturierte Extrakt wird auch in Notion gespeichert.
Teilweise können diese Probleme durch die Praxis interner Berichte gelöst werden. Einmal pro Woche werden 40-60 Minuten zu einer weniger anstrengenden Zeit genommen – und die Jungs machen einen Videobericht für Kollegen aus verschiedenen Projekten. Frontend-Team des Schlüsselprodukts – Vimbox – über Ihr UI-Kit, das für jedes andere Projekt thematisiert werden kann. Das Marketing-Entwicklungsteam sprach über eine Bibliothek zur Nachverfolgung und Protokollierung von Anfragen, was sofort das Interesse mehrerer anderer Projekte weckte. Das Mathematik-Projektteam teilte seine Erfahrungen beim Wechsel von der REST-API zu GraphQL. Das Gruppenunterrichtsteam denkt darüber nach, mitzuteilen, wie sie als erste auf PHP 7.4 umgestiegen sind. Usw.
Die Liste wird seit Mai 2018 geführt und umfasst über 120 Einträge
Alle Besprechungen werden über Google Meet des Unternehmens gestartet, aufgezeichnet und innerhalb von 1.5 Stunden in einem Ordner auf einem freigegebenen Google-Laufwerk angezeigt. Links zu den Aufzeichnungen werden im selben Slack dupliziert. Das heißt, Sie müssen nicht kommen, wenn es einen Notfall gibt, sondern schauen sich das Ganze später mit 20-facher Geschwindigkeit an – normalerweise dauert der Bericht selbst bis zu XNUMX Minuten und die Diskussion – wie es ausgeht. Aber wir gehen nicht über die Stunde hinaus)
PS Was hat bei Ihnen funktioniert und was nicht?
Nützliche Links:
- Rodion Nagornov von Kaspersky Lab über und warum dies keine Dokumentation ist (danke an Igors Kanal für den Link , davon gibt es noch viel mehr).
- Igor Tsupko aus Flant darüber in meiner Firma
- Alexey Kataev aus Skyeng (Wissenslücken in Technologien und spezifischen Bereichen) in einem verteilten Team.
- Sergey Goncharuk aus Flant über die Informationsvermittlung - , wenn Sie in einem verteilten Team auf ein Problem stoßen.
Source: habr.com