Comment nous mesurons la qualité et l'efficacité du développement de la documentation. Contexte et notions de base. Rapport Yandex

Dit Svetlana Kayushina, chef du service de documentation et de localisation.



Notre service de documentation est passé par plusieurs étapes de développement. Il y avait d'abord un rédacteur technique qui effectuait les tâches d'un client individuel. Ensuite, un groupe de rédacteurs techniques a été formé, qui a résolu un ensemble limité de tâches. Nous avons maintenant un grand département de production - il répond pleinement aux besoins de l'entreprise en matière de documentation.



À chaque étape, les exigences relatives au travail du département ont changé et de nouvelles mesures ont semblé mesurer la qualité de la documentation et le service de prestation de services de documentation. Les mesures nous aident à améliorer le produit, les processus et la qualité, ainsi qu'à informer en temps opportun des défaillances.


Premières mesures


Yandex avait besoin du premier rédacteur technique pour documenter la technologie utilisée par presque tous les développeurs. Les informations à ce sujet ont été transmises oralement entre elles, de sorte qu'une partie de celles-ci a inévitablement été perdue ou déformée.


La documentation a été écrite, les clients étaient satisfaits, nous avons donc décidé de maîtriser d'autres domaines. Nous avons commencé par une description des services essentiels à l'entreprise: ils sont utilisés par de nombreux employés de l'entreprise.


Au stade initial, les clients nous ont confié la tâche de documenter la technologie. La seule mesure était la disponibilité de la documentation: elle était écrite ou non. Lorsqu'un rédacteur technique était seul, la qualité était évaluée par le client lui-même. Quand il y avait plus d'écrivains, des consultants de service ont rejoint les clients et nous avons vérifié la qualité de la documentation au sein du département.



Le flux des tâches augmentait constamment, il y avait donc un problème avec le maintien d'un seul niveau de qualité. L'évaluation par un expert est plutôt subjective, mais nous voulions qu'elle soit indépendante.


De plus, les clients ont proposé des tâches de complexité variable: par exemple, capturer des informations qu'une personne connaissait ou décrire une technologie complexe pour développer nos produits externes.


Tout cela a créé certains problèmes, nous avions donc besoin d'un système pour hiérarchiser les tâches et évaluer la qualité de la documentation.


Mesures de la documentation interne


Nous avons commencé à recueillir les commentaires des clients internes et des lecteurs qui ont utilisé la documentation pour résoudre leurs problèmes. Par exemple, un client pourrait nous dire qu'il a cessé de consulter ses collègues 10 heures par semaine et fait maintenant son travail principal de manière plus productive.


Nous avons demandé aux lecteurs dans quelle mesure la documentation les aide à résoudre les problèmes. Présence suivie: combien d'utilisateurs par semaine accèdent aux documents. Si plus d'un certain nombre, le document mérite d'être soutenu.



Cette méthode a nécessité des coûts importants et un accès direct au client. Dans des conditions d'utilisation massive de la documentation, celle-ci s'est révélée trop coûteuse et peu applicable. Par conséquent, lorsque nous avons commencé à développer la documentation pour les utilisateurs externes, des problèmes sont apparus.


L'audience s'est élargie, nous n'y avons pas eu d'accès direct. Nous avons suivi les avis sur les réseaux sociaux et les demandes d'assistance technique, mais ce n'était pas suffisant. J'ai dû construire des hypothèses sur qui est notre utilisateur pour satisfaire au maximum ses besoins. Pour évaluer le comportement des utilisateurs et les performances du produit, nous avons utilisé Yandex.Metrica.


Développement d'un système métrique pour la documentation externe



Les objectifs commerciaux n'ont pas beaucoup changé, mais une nouvelle condition est apparue: nous avons dû réussir à préparer la documentation pour la sortie officielle. Maintenant, nous devions respecter les délais.


Nous avons continué à utiliser les mesures précédentes, mais la fréquentation et les refus du service de documentation y ont été ajoutés. Ils ont été suivis à la fois pour le service dans son ensemble et pour les documents individuels.


Les rédacteurs techniques ont utilisé des données supplémentaires pour améliorer la qualité de la documentation:


  • analyse du comportement des utilisateurs sur le service,
  • carte thermique des clics,
  • visionneuse Web
  • évaluation des requêtes de recherche, etc.

Ensuite, nous sommes passés à l'étape de la production de masse et sommes devenus un service de fourniture de services de documentation.


Documentation Métriques de production en série


À ce stade, les clients et la direction ont de nouvelles exigences pour le service de documentation.


Les clients étaient intéressés par le calendrier et l'évaluation de la complexité des tâches. Par exemple, ils ont demandé pourquoi nous écrivons un document pendant deux semaines, pas deux jours. En même temps, ils attendaient de nous une qualité élevée.


La direction était intéressée par la justification des coûts. Pour embaucher une personne au ministère, nous avons dû en discuter. Par exemple, nous pourrions montrer un avantage mesurable d'un document s'il résout les problèmes non pas de quelques utilisateurs, mais de plusieurs milliers, et réduit la charge sur le support technique.


Nos mesures statistiques n'étaient plus suffisantes pour répondre à ces questions.



Dans le cadre de la production de masse, nous avons plusieurs tâches principales:


  1. technologie documentaire
  2. suivre les versions,
  3. fournir un haut niveau de qualité.

Cela nécessite une approche intégrée de tout ce que nous faisons.


De plus, nous, en tant que service, devons évaluer la qualité de nos services. Nous devons comprendre à quel point les utilisateurs sont satisfaits et quels sont les avantages d'une documentation de haute qualité.


Pour développer un nouveau système d'évaluation, nous avons mené une étude et analysé un grand nombre de sources: un total de 136 paramètres ont été trouvés. Outre le fait qu'ils sont trop nombreux, ils ne sont pas tous faciles à mesurer et nous n'avons pas besoin de tous. Par conséquent, nous avons choisi des mesures adaptées à nos conditions.



Nous nous sommes intéressés aux aspects suivants de l'évaluation:


  1. La conception et les métriques commerciales sont des indicateurs de l'efficacité de la qualité du service dans son ensemble. Ils sont nécessaires pour augmenter la satisfaction client et prévoir les ressources du département pour effectuer toutes les tâches.
  2. Documenter les mesures d'évaluation de la qualité pour améliorer la satisfaction des utilisateurs.

Lors du choix des métriques, nous avons pris en compte la complexité et le coût de calcul de la métrique. Il est également important pour nous que l'essence et le calcul de la métrique soient clairs pour les personnes qui ne sont pas plongées dans les nuances de notre processus de production.


Par conséquent, nous avons sélectionné 20 des 136 mesures, puis les avons divisées en quatre groupes. Nous affichons des données métriques sur des tableaux de bord qui sont disponibles pour tout employé de l'entreprise.



Dans la prochaine partie de l'article, nous décrirons plus en détail les métriques pour le développement et le support de la documentation et comment nous les considérons. Inscrivez-vous pour de nouveaux commentaires - nous vous informerons en eux de la publication de la prochaine partie du rapport.

Source: https://habr.com/ru/post/fr443900/


All Articles