Phase actuelle:
Développement de la documentation. Consultez le calendrier.
Cette page contient des conseils destinés aux organisations Open Source pour évaluer et sélectionner le bon rédacteur technique pour leur proposition de projet Google Season of Docs.
Introduction
Les organisations Open Source doivent embaucher un rédacteur technique pour travailler sur le projet proposé. Les entreprises doivent se procurer leur propre rédacteur technique. Les rédacteurs techniques qui souhaitent travailler avec des organisations participant à Google Season of Docs se trouvent dans le dépôt GitHub Google Season of Docs et sur la chaîne#season-of-docs dans le Slack "Write the Docs".
Début du processus
Nous vous recommandons de rechercher un rédacteur technique dès que vous pensez vouloir participer à la saison des documents Google.
Évaluation d'un rédacteur technique
Nous vous recommandons de demander aux rédacteurs techniques que vous envisagez de fournir des exemples de documentation déjà développées afin d'évaluer leurs compétences et leur expérience de rédaction technique.
Expérience et compétences en rédaction technique
Examinez l'expérience antérieure du rédacteur technique. Dans l'idéal, le rédacteur technique doit avoir une expérience préalable de la rédaction de documentations techniques pour l'industrie logicielle. L'un des objectifs de Google Season of Docs est de donner aux rédacteurs techniques la possibilité de s'impliquer dans les produits destinés aux développeurs. Pour cette raison, il n'est pas essentiel que le rédacteur connaisse les API, les SDK ou d'autres plates-formes de développement, même si votre projet s'adresse à un public de développeurs.
Concentrez-vous sur le langage et les compétences en communication. Évaluer le travail précédent du rédacteur technique de ce point de vue. Le plus important: comprenez ce que la personne a écrit ? Si vous souhaitez un examen approfondi de la formulation du texte du rédacteur technique, recherchez la cohérence au niveau de la ponctuation et de la formulation, l'orthographe et la clarté. La formulation est-elle simple ou compliquée ? Les phrases sont-elles courtes ou s’étendent-elles jusqu’à ce qu’elles deviennent difficiles à suivre ?
Faites attention à la conception et à la mise en page du document. Vérifiez la mise en page globale des exemples de documents. La conception est-elle logique ? Pouvez-vous facilement vous repérer dans le document ou l'ensemble de documentation ? Y a-t-il des contenus en double ou des lacunes évidentes ?
Embaucher un rédacteur technique
Les organisations doivent embaucher un rédacteur technique et remplir le formulaire d'embauche de rédacteur technique en lien ci-dessous d'ici le 22 mai 2024 à 18h (UTC).
Phase de recrutement du rédacteur technique terminée.
Avant de procéder à l'embauche, veillez à discuter de la compensation et de l'échéancier des paiements avec le rédacteur technique. Nous recommandons aux entreprises de créer un échéancier des paiements avec les rédacteurs techniques en fonction des étapes du projet, y compris un paiement au lancement du projet. Tenez compte des dates de paiement, qui n'arriveront que deux fois au cours du programme, et des montants lors de la création d'un échéancier de paiement.
Remarque : Les organisations qui n'ont pas engagé de rédacteur technique et qui ont envoyé le formulaire de preuve d'embauche d'un rédacteur technique avant le 22 mai 2024 à 18h UTC ne recevront pas de fonds à la date du premier versement.