Aller au contenu
BigTree108

Services de rédaction technique

Services de rédaction technique pour les éditeurs de logiciels : références d’API, guides pour développeurs, documentation utilisateur, runbooks et notes de version, écrits comme du code à côté du produit et tenus à jour à chaque livraison.

Ce que font nos rédacteurs techniques

  • Documentation d’API

    Référence générée à partir de votre schéma OpenAPI ou GraphQL, avec des guides de prise en main, des pas-à-pas d’authentification et des exemples exécutables écrits autour, de sorte que la référence n’est jamais modifiée à la main.

  • Docs as code

    Documentation en Markdown dans votre dépôt, relue en pull request comme du code et publiée avec Docusaurus, Starlight ou un générateur similaire par le même pipeline que le produit.

  • Guides utilisateur et centres d’aide

    Guides par tâche et articles de centre d’aide organisés selon ce que le lecteur cherche à faire, répartis en tutoriels, guides pratiques, référence et explication selon le cadre Diátaxis.

  • Runbooks et guides d’exploitation

    Procédures pas à pas pour les déploiements, les restaurations, la réponse aux incidents et les astreintes, testées par quelqu’un qui ne les a pas écrites.

  • Notes de version et changelogs

    Notes de version qui disent aux utilisateurs ce qui a changé pour eux, et changelogs pour les intégrateurs, rédigés à partir des pull requests fusionnées et vérifiés par rapport à la livraison.

  • Contrôles de style et de qualité

    Un guide de style et un glossaire appliqués par Vale dans le pipeline, avec une vérification des liens rompus à chaque build, pour que la cohérence ne repose pas sur un seul relecteur.

Recruter des rédacteurs techniques

  • À temps plein dans votre équipe

    Des Rédacteurs techniques qui travaillent selon vos horaires, avec vos outils et dans vos réunions, et rendent compte à votre responsable ; le contrat ukrainien, la paie et les congés restent de notre côté.

  • À temps partiel ou à temps partagé

    Des Rédacteurs techniques pour un nombre de jours par semaine défini, lorsque le travail est réel mais ne justifie pas encore un poste à temps plein.

  • Pour un projet ou un lancement

    Des Rédacteurs techniques pour une période de travail définie, de la première semaine à la passation, avec une date de fin convenue dès le départ.

La page Équipe dédiée explique comment les spécialistes rejoignent votre équipe, et la page Externalisation couvre la livraison de projet, les reprises et notre mode de facturation.

Avec qui travaillent nos rédacteurs techniques

  • Ingénieurs et responsables techniques

    Entretiens, relectures et exactitude technique

  • Product managers

    Fonctionnalités, publics et périmètre des versions

  • Ingénieurs support

    Les questions que les utilisateurs se posent réellement

  • Designers UI et UX

    Textes d’interface et schémas

Comment travaillent nos rédacteurs techniques

La documentation vit là où vit le code : dans le dépôt, relue dans la même pull request que la modification qu’elle décrit, puis construite et publiée par le pipeline. Une fonctionnalité est terminée quand sa documentation est fusionnée, ce qui maintient la documentation aussi à jour que le code.

Le travail part du lecteur : qui il est, ce qu’il cherche à faire et ce qu’il sait déjà. Les tickets de support et les termes recherchés montrent où la documentation actuelle est défaillante, et ces pages sont corrigées en premier.

Autres profils que nous mettons à disposition

Rôles d’équipe : vue d’ensemble

Questions sur le recrutement des rédacteurs techniques

Un rédacteur technique peut-il documenter un système que personne n’a documenté ?

Oui. Le rédacteur lit le code et la configuration, interroge les ingénieurs et produit une vue d’ensemble de l’architecture, des runbooks et un glossaire, relus par les personnes qui exploitent le système. C’est la même première étape, en lecture seule, que celle de nos reprises de systèmes hérités.

Comment maintenez-vous la documentation d’API en phase avec l’API ?

La référence est générée à partir du schéma OpenAPI ou GraphQL lors du build ; elle ne peut donc pas s’écarter de l’API. Le rédacteur ajoute ce qu’un générateur ne sait pas faire : le guide de démarrage, le pas-à-pas d’authentification et les exemples dont un développeur a besoin avant que la référence ne lui soit utile.

En combien de temps les rédacteurs techniques peuvent-ils démarrer ?

Lorsque le bon rédacteur technique est disponible, le démarrage ne dépend que de votre entretien, du NDA et de la cession de propriété intellectuelle. Sinon, nous lançons une recherche, qui fournit en général des profils de candidats sous deux à trois semaines, et personne ne démarre avant que vous ayez donné votre accord.

Comment recruter des rédacteurs techniques via BigTree108 ?

Indiquez-nous le travail à réaliser, le niveau de séniorité et les horaires dont vous avez besoin. Nous vous proposons une ou deux personnes avec leurs profils, vous les interviewez comme vous le feriez pour votre propre recrutement, puis vous signez un seul contrat avec BIG TREE 108 LLC et recevez une facture par mois.

À qui appartient le travail qu’ils produisent ?

C’est vous. Chaque spécialiste a signé avec BigTree108 un contrat qui cède à l’entreprise tous les livrables, et notre contrat avec vous vous les cède à son tour. Le code, les maquettes et les documents sont livrés dans vos propres dépôts et outils, et non conservés à un endroit où nous seuls pourrions les modifier.

Votre documentation est-elle en retard sur votre produit ?

Indiquez-nous le produit, ses lecteurs et l’endroit où se trouve aujourd’hui la documentation. Vous recevez une réponse sous un jour ouvré : des profils de candidats ou un plan de documentation.

Écrire à hello@bigtree108.comComment nous répondons