Phase actuelle:
Le programme Season of Docs 2021 s'est terminé le 14 décembre 2021. Voir la chronologie.
Cette page s'adresse aux organisations Open Source qui se trouvent dans la phase d'exploration du processus de candidature. Ces idées de projets ne sont que des exemples pour montrer comment les organisations peuvent décrire des projets de documentation possibles sur leur page d'idées de projets. Les organisations peuvent proposer des projets qui ne figurent pas dans cette liste.
Idée de projet: créer un guide d'intégration pour les contributeurs
Problème
- Les nouveaux contributeurs ne parviennent pas à trouver les informations de configuration dont ils ont besoin pour apporter une contribution significative à notre projet. Certains processus (comme la contribution à nos tests) ne sont pas du tout documentés.
Comment mesurer le succès ?
- Augmentation du nombre de nouveaux contributeurs
- Augmentation du nombre de nouveaux contributeurs non-code (en facilitant la contribution aux documents ou aux tests)
- Diminution du nombre de problèmes soulevés par les nouveaux contributeurs
- Augmentation du nombre de problèmes fermés tagués comme "bon premier problème"
De quelles compétences un rédacteur technique a-t-il besoin pour travailler sur ce projet ?
- Compétences requises:connaissance de GitHub (ou volonté de suivre des tutoriels GitHub)
- Souhaitable:connaissance de notre outil de test pour exécuter nos tests et mettre à jour la documentation à cet effet
Bénévoles
Encouragez les membres de la communauté à s'inscrire pour vous aider à effectuer des tâches spécifiques, par exemple:
- @JaneQDev peut répondre à vos questions sur nos tests
- @ChenPCoder, je suis ravi d'examiner les demandes d'extraction de documents.
- @ErichJEngineer, can walk through current contribution process with technical writer
Coordonnées
- Les rédacteurs techniques intéressés par ce projet doivent envoyer un e-mail à email@project. Veuillez inclure des liens vers votre travail de rédaction technique ou votre portfolio/résumé/CV.
Idée de projet: écrire des tutoriels pour utiliser notre bibliothèque avec…
Problème
- Notre projet fait l'objet de nombreux problèmes soulevés par des utilisateurs qui tentent d'utiliser notre bibliothèque avec $TechnologyX. Nous ne disposons pas d'un guide clair pour l'intégration avec $TechnologyX, et cela peut être délicat.
Comment mesurer le succès ?
- Diminution du nombre de problèmes tagués "$TechnologyX"
- Augmentation du nombre de requêtes pull de nouveaux contributeurs qui nous aident à corriger des bugs ou à enrichir la documentation sur $TechnologyX
- Autres liens vers notre projet à partir de projets $TechnologyX
De quelles compétences un rédacteur technique a-t-il besoin pour travailler sur ce projet ?
- Souhaitable:connaissance de $TechnologyX
Bénévoles
Encouragez les membres de la communauté à s'inscrire pour vous aider à effectuer des tâches spécifiques, par exemple:
- @JaneQDev, peut répondre à vos questions sur $TechnologyX
- @ChenPCoder, je suis ravi d'examiner les demandes d'extraction de documents.
Coordonnées
- Les rédacteurs techniques intéressés par ce projet doivent envoyer un e-mail à email@project. Veuillez inclure des liens vers votre travail de rédaction technique ou votre portfolio/résumé/CV.
Idée de projet: réorganiser notre documentation
Problème
- Notre documentation est étendue et désorganisée. De nombreux utilisateurs abandonnent leur recherche de réponses dans la documentation et se contentent de signaler des problèmes ou de poser des questions sur nos forums. Nos pages n'apparaissent pas dans les résultats de recherche, même pour les mots clés pertinents.
Comment mesurer le succès ?
- Amélioration du référencement naturel de notre documentation
- Réduction du nombre de problèmes soulevés pour les sujets abordés dans la documentation
- Augmentation du nombre de contributions à la documentation
De quelles compétences un rédacteur technique a-t-il besoin pour travailler sur ce projet ?
- Compétences souhaitées:expérience de la réorganisation de grands ensembles de documentation matures, connaissance du référencement SEO
Bénévoles
Encouragez les membres de la communauté à s'inscrire pour vous aider à effectuer des tâches spécifiques, par exemple:
- @ChenPCoder, je suis ravi d'examiner les demandes d'extraction de documents.
Coordonnées
- Les rédacteurs techniques intéressés par ce projet doivent envoyer un e-mail à email@project. Veuillez inclure des liens vers votre travail de rédaction technique ou votre portfolio/résumé/CV.
Idée de projet: exécuter une correction de documentation
Problème
- Nous avons beaucoup de petits bugs et d'anciens problèmes liés à notre documentation. Notre communauté serait ravie de vous aider à nettoyer, mais nous avons besoin de quelqu'un pour organiser et gérer l'opération.
Comment mesurer le succès ?
- Nombre de problèmes liés à la documentation résolus
- Augmentation du nombre de contributions à la documentation et de nouveaux contributeurs
De quelles compétences un rédacteur technique a-t-il besoin pour travailler sur ce projet ?
- Souhaitable:expérience de l'exécution d'une correction de documentation
- Excellentes compétences organisationnelles
Bénévoles
Encouragez les membres de la communauté à s'inscrire pour vous aider à effectuer des tâches spécifiques, par exemple:
- @ChenPCoder peut vous aider à organiser la vidéo et le chat pour la réparation et à trouver des bénévoles dans d'autres fuseaux horaires.
Coordonnées
- Les rédacteurs techniques intéressés par ce projet doivent envoyer un e-mail à email@project/ouvrir un problème/poser une question sur notre forum. Veuillez inclure des liens vers votre travail de rédaction technique ou votre portfolio/résumé/CV.
Idée de projet: effectuer un audit de la documentation
Problème
- Nous n'avons pas une bonne idée de l'état de notre documentation. Il est difficile de hiérarchiser les améliorations de la documentation, car nous n'avons pas de feuille de route ni d'idée des problèmes les plus urgents. Nous avons également beaucoup de contenus obsolètes qui doivent être supprimés ou archivés.
Comment mesurer le succès ?
- Création d'une feuille de route de documentation avec l'approbation générale de la communauté
- Réduction du nombre de pages de documentation obsolètes ou incorrectes
De quelles compétences un rédacteur technique a-t-il besoin pour travailler sur ce projet ?
- Souhaitable:expérience en audit de documents
Bénévoles
Encouragez les membres de la communauté à s'inscrire pour vous aider à effectuer des tâches spécifiques, par exemple:
- @JaneQCoder, peut aider à coordonner la présentation de la feuille de route de la documentation lors de notre réunion de la communauté
Coordonnées
- Les rédacteurs techniques intéressés par ce projet doivent envoyer un e-mail à email@project/ouvrir un problème/poser une question sur notre forum. Veuillez inclure des liens vers votre travail de rédaction technique ou votre portfolio/résumé/CV.
Informations connexes
- La page Promotion et presse inclut des logos et d'autres contenus que vous pouvez utiliser lorsque vous parlez de la saison Google des documents.
- Cette vidéo de la conférence PyCon Australia 2017 vous donne des conseils pour organiser votre documentation afin qu'elle soit utile : What nobody tells you about documentation (Ce que personne ne vous dit sur la documentation) par Daniele Procida.