Phase actuelle:
Développement de la documentation. Consultez le calendrier.
Cette page s'adresse aux organisations Open Source qui sont en phase d'exploration du processus d'application de l'organisation. Ces idées de projet ne sont que des exemples illustrant comment les organisations peuvent décrire d'éventuels projets de documentation 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 des contributeurs
Problème
- Les nouveaux contributeurs ne trouvent pas les informations de configuration dont ils ont besoin pour contribuer de manière significative à notre projet. Certains processus (tels que 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 sans code (en facilitant la contribution aux documents ou aux tests)
- Baisse du nombre de problèmes signalés par les nouveaux contributeurs
- Augmentation du nombre de problèmes fermés associés à la mention "bon premier problème"
Quelles compétences un rédacteur technique aurait-il besoin pour travailler sur ce projet ?
- Requis:connaissance de GitHub (ou volonté d'utiliser les tutoriels GitHub).
- Bon à avoir:une bonne connaissance du lanceur de test vous permet d'exécuter des tests et de mettre à jour la documentation correspondante.
Bénévoles
Encouragez les membres de la communauté à s'inscrire pour les aider à effectuer des tâches spécifiques. Par exemple:
- @JaneQDev peut vous aider à répondre aux questions sur nos tests
- @ChenPCoder, heureux d'examiner les demandes d'extraction des documents
- @ErichJEngineer, peut présenter le processus de contribution actuel avec le rédacteur technique
Coordonnées
- Les rédacteurs techniques intéressés par ce projet doivent envoyer un e-mail à l'adresse email@project. Incluez des liens vers vos travaux de rédaction technique ou votre portfolio/CV.
Project Idea: écrire des tutoriels pour utiliser notre bibliothèque avec ...
Problème
- Notre projet entraîne de nombreux problèmes soulevés par les utilisateurs qui essaient d'utiliser notre bibliothèque avec $TechnologyX. Nous n'avons pas de guide clair sur l'intégration à $TechnologyX, et cela peut s'avérer délicat.
Comment mesurer le succès ?
- de baisse du nombre de problèmes associés à la balise "$TechnologyX" ;
- Augmentation du nombre de demandes d'extraction de nouveaux contributeurs, ce qui nous aide à corriger des bugs ou à compléter la documentation sur $TechnologyX
- Autres liens vers notre projet issus des projets $TechnologyX
Quelles compétences un rédacteur technique aurait-il besoin pour travailler sur ce projet ?
- Souhaitable:une certaine connaissance de $TechnologyX.
Bénévoles
Encouragez les membres de la communauté à s'inscrire pour les aider à effectuer des tâches spécifiques. Par exemple:
- @JaneQDev peut vous aider à répondre à vos questions sur $TechnologyX
- @ChenPCoder, heureux d'examiner les demandes d'extraction des documents
Coordonnées
- Les rédacteurs techniques intéressés par ce projet doivent envoyer un e-mail à l'adresse email@project. Incluez des liens vers vos travaux de rédaction technique ou votre portfolio/CV.
Project Idea: réorganiser notre documentation
Problème
- Notre documentation est vaste et désorganisée. De nombreux utilisateurs renoncent à chercher des réponses dans la documentation et se contentent de soulever 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 des mots clés pertinents.
Comment mesurer le succès ?
- Améliorer le SEO pour notre documentation
- Baisse du nombre de problèmes soulevés pour les sujets abordés dans la documentation
- Augmentation du nombre de contributions à la documentation
Quelles compétences un rédacteur technique aurait-il besoin pour travailler sur ce projet ?
- Bon à avoir:expérience dans l'organisation de documents volumineux et matures, compréhension du SEO
Bénévoles
Encouragez les membres de la communauté à s'inscrire pour les aider à effectuer des tâches spécifiques. Par exemple:
- @ChenPCoder, heureux d'examiner les demandes d'extraction des documents
Coordonnées
- Les rédacteurs techniques intéressés par ce projet doivent envoyer un e-mail à l'adresse email@project. Incluez des liens vers vos travaux de rédaction technique ou votre portfolio/CV.
Idée de projet: exécuter un correctif de documentation
Problème
- Nous avons beaucoup de petits bugs et d'anciens problèmes liés à notre documentation. Notre communauté se fera un plaisir d'intervenir et de contribuer au nettoyage, mais nous avons besoin d'une personne pour organiser et corriger le problème.
Comment mesurer le succès ?
- Nombre de problèmes liés à la documentation fermés
- Augmentation du nombre de contributions à la documentation et du nombre de nouveaux contributeurs
Quelles compétences un rédacteur technique aurait-il besoin pour travailler sur ce projet ?
- Bon à avoir:expérience de l'exécution d'un correctif de documentation.
- Excellentes compétences organisationnelles
Bénévoles
Encouragez les membres de la communauté à s'inscrire pour les aider à effectuer des tâches spécifiques. Par exemple:
- @ChenPCoder, peut aider à organiser la vidéo et le chat pour le correctif 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 ou poser une question sur notre forum. Incluez des liens vers vos travaux de rédaction technique ou votre portfolio/CV.
Idée de projet: réaliser 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 de idée des problèmes les plus urgents. Nous disposons également d'un grand nombre de contenus obsolètes qui doivent être supprimés ou archivés.
Comment mesurer le succès ?
- Création d'une feuille de route pour la documentation avec l'approbation générale de la communauté
- Baisse du nombre de pages de documentation obsolètes ou incorrectes
Quelles compétences un rédacteur technique aurait-il besoin pour travailler sur ce projet ?
- Bon à avoir:expérience dans le domaine de l'audit de documents
Bénévoles
Encouragez les membres de la communauté à s'inscrire pour les aider à effectuer des tâches spécifiques. Par exemple:
- @JaneQCoder, peut nous aider à coordonner la présentation de la feuille de route de la documentation lors de notre réunion communautaire
Coordonnées
- Les rédacteurs techniques intéressés par ce projet doivent envoyer un e-mail à email@project/ouvrir un problème ou poser une question sur notre forum. Incluez des liens vers vos travaux de rédaction technique ou votre portfolio/CV.
Informations connexes
- La page Promotion et presse inclut des logos et d'autres contenus que vous pouvez utiliser lorsque vous parlez de Google Season of Docs.
- Cette vidéo de PyCon Australia 2017 donne des conseils sur l'organisation de votre documentation afin que les utilisateurs la trouvent utile : What nobody know about documentation (Ce que personne ne vous dit sur la documentation) de Daniele Procida.