L'entreprise informatique moyenne a des exigences, un historique des suivis de tâches, des sources (peut-être même avec des commentaires dans le code), des instructions pour les cas typiques, importants et complexes en production, une description des processus métier (de l'intégration à « comment partir en vacances "), contacts, clés d'accès, listes de personnes et de projets, descriptions des domaines de responsabilité - et un tas d'autres connaissances que nous avons probablement oubliées et qui peuvent être stockées dans les endroits les plus étonnants.
Connaissance =/= documentation. Cela ne s'explique pas, il faut se rappeler
Comment s'assurer que ceux qui ont besoin de savoir quelque chose à partir de cela comprennent où et comment le trouver, et que tous ceux qui ont besoin d'être au courant de choses et d'accords individuels peuvent connaître instantanément et avec précision les changements qui y sont apportés.
Dans le dernier épisode du podcast « Team Lead Will Call », les gars de Skyeng ont parlé de gestion des connaissances avec Igor Tsupko est membre du comité du programme KnowledgeConf et le « directeur de l'inconnu » chez Flant.
L'enregistrement complet est disponible sous , et ci-dessous, nous avons rassemblé quelques conseils intéressants et des liens vers des documents utiles qui ont été mentionnés dans l'audio ou qui en développent les informations. Ce serait formidable si vous partagiez également les astuces et astuces de votre équipe dans les commentaires.
Premier hack : vous n’avez plus besoin de savoir dans quel système regarder
« J'ai pris nos sources de connaissances et j'ai fait une recherche générale : une fenêtre unique avec un système de filtrage pour réduire la zone de recherche. Oui, en même temps, vous devez toujours surveiller sa qualité, reconstituer la base de connaissances et lutter contre la duplication et les informations erronées.
Un morceau de papier pour trouver c'est tout
Mais déjà, environ 60 % des ingénieurs de Flant utilisent cette recherche au moins 1 à 2 fois par jour - et trouvent généralement les réponses en première ou en deuxième position. Et sous forme de preuve de concept, l'indexation des documents Google : tous les documents, dossiers, camionnettes, etc. - tout cela est également facilement intégré dans la recherche interne.
Deuxième hack : comment ne pas manquer des éléments cruciaux dans une série de discussions
« Si vous travaillez dans une équipe distribuée, alors une partie importante de votre journée est probablement passée dans Slack - et dans ce cas, vous avez l'habitude de faire quelque chose comme ceci : « @myteam, aidez/regardez/saisissez le bon... "." Mais il y a un problème avec l'abondance d'informations - et une mention distincte peut manquer parmi d'autres messages.
Chez Skyeng, nous sommes aidés par un robot grâce auquel vous pouvez écrire un message et identifier un nombre illimité de personnes ou de groupes. Nous l'utilisons dans les cas où il est vraiment important que les gens lisent ou réagissent : il poussera sans fin jusqu'à ce que vous appuyiez sur le bouton « Je lis » - vous ne pourrez pas l'ignorer ou l'ignorer.
Question à répondre : que faire de la documentation ?
« Une grande partie des connaissances proviennent des techniciens, mais tout le monde ne sait pas bien les décrire.
Après tout, vous n'avez aucun compilateur ou linter qui vous dirait si vous le faites correctement ou non - et souvent le résultat que nous obtenons est un texte incompréhensible, mal formaté et incomplet. Bien sûr, vous devez le faire normalement, pas parce que quelqu'un est venu et vous a dit « c'est nécessaire » - vous le faites bien pour vous-même : dans un mois ou deux, vous le lirez et comprendrez. Et une autre personne, ouvrant un document, ne le fermera pas immédiatement pour toujours, se rendant compte qu'il est inutile.
Partie du podcast dédiée à la question « Combien de personnes faut-il pour rédiger une bonne documentation ou réaliser une démo normale »
Mais la question demeure : combien de temps y consacrer et comment le faire efficacement ?
Et s’il existe une réponse honnête : à moins que les hommes d’affaires ne soient impliqués et à moins qu’ils ne subissent empiriquement l’impact d’une bonne documentation, l’effort risque d’être peu rentable. Il s’agit plutôt d’une histoire de changement de culture.
Pour le reste, l'expérience et le mentorat vous sauveront. Des analogues de programmation en binôme, de suivi des progrès et de révision de code peuvent convenir ici - montrant les meilleures pratiques, pointant vers les erreurs et finalement ennuyeux.
Bonus : « Okay, je vais leur dire comme ça, ils comprendront »
La question « combien de temps y consacrer et à quel niveau le faire » est importante non seulement dans le cadre de la documentation, mais en général pour le transfert de tout savoir. La démo est également un excellent exemple de partage d’informations. Mais il y a des nuances : par exemple, comment s'assurer qu'ils prennent un minimum de temps.
Canal de partage de connaissances entre développement : rapports internes, livres utiles, articles, etc. L'extrait structuré est également stocké dans Notion.
Ces problèmes peuvent être en partie résolus par la pratique des rapports internes. Une fois par semaine, 40 à 60 minutes sont prises à un moment moins chargé - et les gars réalisent un reportage vidéo pour les collègues de différents projets. Équipe frontend du produit clé - Vimbox - à propos de votre kit d'interface utilisateur, qui peut être thématique pour tout autre projet. L'équipe de développement marketing a parlé d'une bibliothèque de traçage et de journalisation des demandes, qui a immédiatement suscité l'intérêt de plusieurs autres projets. L'équipe du projet Mathematics a partagé son expérience du passage de l'API REST à GraphQL. L'équipe des cours collectifs pense partager comment ils ont été les premiers à passer à PHP 7.4. Et ainsi de suite.
La liste est maintenue depuis mai 2018 et compte plus de 120 entrées
Toutes les réunions sont démarrées via Google Meet d'entreprise, enregistrées et apparaissent dans les 1.5 heures dans un dossier sur un lecteur Google partagé, et les liens vers les enregistrements sont dupliqués dans le même Slack. Autrement dit, vous n'êtes pas obligé de venir en cas d'urgence, mais regardez-le plus tard à une vitesse de 20 - généralement le rapport lui-même dure jusqu'à XNUMX minutes, et la discussion - comment cela se passe. Mais on ne dépasse pas l'heure)
PS Qu'est-ce qui a fonctionné et n'a pas fonctionné pour vous ?
Liens utiles:
- Rodion Nagornov de Kaspersky Lab à propos et pourquoi ce n'est pas de la documentation (merci à la chaîne d'Igor pour le lien , il y en a beaucoup d'autres comme ça).
- Igor Tsupko de Flant à ce sujet dans mon entreprise
- Alexeï Kataïev de Skyeng (lacunes de connaissances dans les technologies et les domaines spécifiques) dans une équipe distribuée.
- Sergey Goncharuk de Flant à propos de la transmission d'informations - , si vous rencontrez un problème dans une équipe distribuée.
Source: habr.com