Général
DocMeThis fonctionne avec quels langages de programmation ? +
DocMeThis a été initialement développé pour Python. Ce choix permet une analyse statique précise des signatures, docstrings, paramètres, retours et structures de code. La prise en charge des langages suivants est prévue courant 2026 : Java, JavaScript, TypeScript, C++, PHP et Ruby. Inscrivez-vous à notre infolettre pour être informé(e) de l’arrivée des nouveaux langages.
DocMeThis remplace-t-il un linter ou des tests ? +
Non. DocMeThis complète vos tests et vos linters. Les tests vérifient que le code fonctionne. Les linters vérifient sa forme. DocMeThis vérifie que la connaissance transmise par la documentation reste alignée avec le code.
Est-ce que DocMeThis est open source ? +
La GitHub Action CI Check et les composants nécessaires à son fonctionnement sont ouverts et publiés sous licence MIT. Par ailleurs, nous pratiquons des tarifs fortement préférentiels pour les projets OSS — et en particulier la gratuité des deux premiers niveaux de nos solutions CI Fix et Audit.
Votre solution est intéressante, mais mon code est strictement confidentiel… +
DocMeThis est tout à fait compatible avec l’analyse de bases de code confidentielles. Selon le niveau de sensibilité, l’analyse peut être réalisée via cloud souverain, runner auto-hébergé, intervention sur site, voire environnement strictement air-gapped. L’audit repose sur une analyse statique : l’application n’a pas besoin d’être exécutée. DocMeThis ne conserve jamais le code fourni par le client.
Offres et tarifs
Qu’est-ce que je reçois après un audit ? +
Vous recevez un rapport priorisé indiquant la couverture documentaire, les incohérences code/doc, les zones de dette par module et les corrections à traiter en priorité, ainsi que la liste complète des symboles à documenter.
Quelle est la différence entre l’offre CI Check et l’offre Audit ? +
L’offre CI Check sert à détecter les dérives documentaires dans la CI, commit après commit. L’offre Audit sert à obtenir une vue d’ensemble de la dette documentaire d’un projet : couverture, zones critiques, incohérences et priorités de correction.
Quelles sont les conditions de gratuité pour les projets OSS ? +
L’offre CI Check est elle-même sous licence MIT, et gratuite sans condition.
Les deux premiers niveaux de l’offre CI Fix sont gratuits pour les projets open source. Un tarif préférentiel sera appliqué au-delà, sur devis.
Les deux premiers niveaux de l’offre Audit sont gratuits pour les projets open source.
L’offre premium Build reste payante, avec tarifs préférentiels, sur devis.
Qu’est-ce qu’un crédit documentaire ? +
Un crédit documentaire est l’unité utilisée par DocMeThis pour quantifier l’utilisation des ressources. Concrètement, le fait de documenter un symbole (classe, fonction, etc.) vaut 3 crédits, et chaque élément documentaire (paramètre, retour, etc.) au sein du symbole vaut 1 crédit. Ce mode de calcul est justifié par la complexité de l’AST.
Exemples :
- PR avec une fonction de deux paramètres et un retour : 3 + 2 + 1 = 6 crédits ;
- PR avec une classe, trois méthodes dont une avec quatre paramètres et un raise : 3 + 3×3 + 4 + 1 = 17 crédits.
Les crédits sont renouvelés mensuellement. Si le quota est atteint, les prestations CI Fix sont suspendues avec un message PR/MR neutre. Vous pouvez compléter votre abonnement avec un pack de 500 crédits supplémentaires pour 9 € (valable 12 mois, consommé après les crédits mensuels).
Le dépassement du quota CI Fix n’a bien évidemment aucun impact sur l’exécution de CI Check, et ne bloque pas la CI, sauf configuration explicite.
DocMeThis modifie-t-il automatiquement mon code ? +
Non, pas sans validation. Les offres de détection signalent les problèmes. Les offres de génération proposent des corrections documentaires, mais celles-ci doivent être validées avant intégration. La validation peut être automatisée, mais cela reste votre choix.
Est-ce que je peux utiliser CI Check et CI Fix pour mettre à jour un projet complet ? +
Les outils CI Check et CI Fix sont conçus pour la maintenance incrémentale : mesurer la dérive documentaire dans la CI et corriger les docstrings au fil des PR/MR.
CI Check possède un mode d’évaluation permettant d’obtenir un diagnostic synthétique de la dette documentaire à l’échelle d’un projet complet, avec un score et quelques statistiques,mais ce résumé ne peut remplacer le diagnostic détaillé, la priorisation et la liste des corrections à mener symbole par symbole, entre autres, qui sont les livrables de notre offre Audit.
Pour rattraper une dette documentaire importante, CI Fix n’est généralement pas adapté : cet outil est pensé pour corriger progressivement, pas pour générer massivement des docstrings sur des centaines de symboles. Si vous avez besoin de supprimer une dette documentaire importante afin de partir sur de bonnes bases pour la maintenance incrémentale, demandez-nous un devis pour la génération des docstrings via l’offre Build.
Le package documentaire de l’offre Build est-il modulable ? +
Bien sûr ! Les besoins diffèrent grandement d’un projet à l’autre, aussi l’offre Build est conçue pour s’adapter à toutes les demandes, que ce soit la simple génération ou correction des docstrings d’un projet, la création d’un package documentaire complet, ou tout niveau intermédiaire de granularité.
Sécurité
Votre solution est intéressante, mais mon code est strictement confidentiel… +
DocMeThis est tout à fait compatible avec l’analyse de bases de code confidentielles. Selon le niveau de sensibilité, l’analyse peut être réalisée via cloud souverain, runner auto-hébergé, intervention sur site, voire environnement strictement air-gapped. L’Audit repose sur une analyse statique : l’application n’a pas besoin d’être exécutée. DocMeThis ne conserve jamais le code fourni par le client.
Dois-je vous fournir mon code source ? +
Pas nécessairement. Les offres CI Check et CI Fix fonctionnent dans votre environnement, et CI Fix s’appuie sur votre propre fournisseur de LLM. Le code ne transite donc pas par nos serveurs. Quant aux offres Audit et Build, nous pouvons également les exécuter depuis votre infrastructure, selon le niveau de confidentialité nécessaire.
Dans tous les cas, nous ne conservons jamais le code qui nous est confié plus de 48 h, et nous n’utilisons jamais les données pour un autre objectif que la création des livrables souscris par le client.
Les GitHub Actions sont-elles sécurisées ? +
Étant donné leur mode d’action, la surface d’exploitation de nos services semble relativement faible en termes de risques. Quoi qu’il en soit, nous faisons notre possible pour suivre les meilleures pratiques en termes de cybersécurité, et une revue externe de sécurité est sur notre feuille de route.
Comment sont sécurisés les paiements ? +
Les données de paiement ne transitent pas par nos serveurs : les paiements par carte et prélèvements en ligne sont traités par Stripe, prestataire spécialisé dans les paiements sécurisés, et les offres à la demande et entreprises peuvent être éligibles aux virements SEPA. DocMeThis ne stocke aucune information bancaire sur ses propres serveurs.
Comment sont sécurisées mes données personnelles ? +
La gestion des abonnements, de la facturation et des quotas est assurée par Chargebee, prestataire spécialisé dans la facturation. DocMeThis limite au maximum la conservation de données client sur ses propres serveurs : nous ne conservons que les informations nécessaires au fonctionnement du service, comme l’identification du compte, les droits d’accès, les informations techniques indispensables et les éléments nécessaires au support client.
Technique
Qu’entendez-vous par génération contrainte et génération déterministe ? +
Ce sont deux notions différentes.
L’inférence d’un LLM repose sur des calculs probabilistes, et n’est donc généralement pas reproductible. La génération est dite déterministe lorsque, pour une même entrée, le modèle produit la même sortie. Certains moteurs d’inférence permettent aujourd’hui, pour certains modèles, de garantir ce déterminisme.
À noter : les fournisseurs de modèles ne sont généralement pas configurés pour proposer cette fonctionnalité. C’est pourquoi notre offre CI Fix n’est pas présentée comme déterministe à ce jour. Seule l’offre Build peut l’être, lorsque nous avons la maîtrise du moteur d’inférence et de sa configuration.
La génération est contrainte lorsque l’espace de génération du modèle est volontairement limité : prompt précis, contexte issu de l’AST, format de sortie restreint, validation et rejet des sorties non conformes, etc.
Ces contraintes ne rendent pas le modèle infaillible, mais elles réduisent fortement le risque d’hallucination et permettent de détecter, rejeter ou corriger les sorties qui ne respectent pas les faits observables dans le code.
L’offre CI Fix inclut-elle l’inférence LLM ? +
Non, seule l’offre Build inclut l’inférence : à ce jour notre infrastructure ne permet pas de fournir un service d’inférence en continu. Le service CI Fix étudie le contexte AST, génère un prompt dédié à chaque élément à documenter, lance la requête LLM, et vérifie la validité de la docstring générée. Il ne consomme donc pas directement les tokens, l’inférence est déléguée au modèle de votre choix, à configurer dans GitHub ou GitLab. Ce système autorise une grande flexibilité : vous pouvez utiliser votre forfait Claude ou ChatGPT, déployer votre propre modèle, ou passer par une API tierce. Nous conseillons l’utilisation d’un modèle léger avec de bonnes performances en développement.
Est-ce que DocMeThis envoie mon code à une IA ? +
L’audit documentaire et la détection de dérive reposent sur de l’analyse statique, sans génération IA. Pour les offres de génération de docstrings, les modalités d’utilisation de l’IA dépendent du niveau de confidentialité choisi.
Puis-je choisir le modèle d’IA ? +
DocMeThis peut utiliser à peu près n’importe quel modèle d’IA générative. Pour la génération documentaire intégrée à la CI, vous pouvez donc choisir le modèle de votre choix. Pour la génération documentaire premium, plus lourde à traiter, nous avons testé et sélectionné plusieurs modèles avec lesquels nous avons l’habitude de travailler, mais le choix final du modèle vous appartiendra.
J’ai déjà un abonnement à une IA générative, puis-je l’utiliser ? +
Oui. DocMeThis ne dépend pas d’un fournisseur IA en particulier, mais a été pensé et conçu pour pouvoir se brancher à n’importe quel fournisseur, ou presque. Que vous souhaitiez utiliser votre abonnement Claude d’Anthropic ou ChatGPT d’OpenAI, ou une API de votre choix, ou encore un modèle déployé localement, tout est possible, ou presque.