Phase actuelle:
annonce des résultats dans le calendrier.
Cette page est destinée aux organisations Open Source qui se trouvent dans la phase d'exploration du processus de candidature 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. Elles peuvent proposer des projets qui ne figurent pas dans cette liste.
Project Idea: créer un guide d'intégration des contributeurs
Problème
- Les nouveaux contributeurs ne peuvent pas trouver les informations de configuration dont ils ont besoin pour contribuer de façon 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 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 marqués comme "bon premier problème"
De quelles compétences un rédacteur technique doit-il disposer pour travailler sur ce projet ?
- indispensable:connaissance de GitHub (ou volonté de suivre des tutoriels GitHub).
- Bon à avoir:connaissance de notre lanceur de test, qui vous aidera à exécuter les tests et à mettre à jour la documentation correspondante.
Bénévoles
Encouragez les membres de la communauté à s'inscrire pour obtenir de l'aide sur des tâches spécifiques. Exemples:
- @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 qui souhaitent travailler sur ce projet doivent envoyer un e-mail à l'adresse email@project. Veuillez inclure 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 reçoit de nombreux problèmes soulevés par des 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 être délicat !
Comment mesurer le succès ?
- de baisse du nombre de problèmes associés à la balise "$TechnologyX" ;
- d'augmentation du nombre de demandes d'extraction de nouveaux contributeurs, qui nous aident à corriger des bugs ou à compléter la documentation sur $TechnologyX.
- Plus de liens vers notre projet $TechnologyX
De quelles compétences un rédacteur technique doit-il disposer pour travailler sur ce projet ?
- Bénéfique:une certaine connaissance de $TechnologyX.
Bénévoles
Encouragez les membres de la communauté à s'inscrire pour obtenir de l'aide sur des tâches spécifiques. Exemples:
- @JaneQDev peut vous aider à répondre aux questions sur $TechnologyX
- @ChenPCoder, heureux d'examiner les demandes d'extraction des documents
Coordonnées
- Les rédacteurs techniques qui souhaitent travailler sur ce projet doivent envoyer un e-mail à l'adresse email@project. Veuillez inclure 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 à essayer de trouver 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élioration du 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
De quelles compétences un rédacteur technique doit-il disposer pour travailler sur ce projet ?
- Bon à avoir:expérience en réorganisation d'ensembles de documentation volumineux et matures, compréhension du SEO.
Bénévoles
Encouragez les membres de la communauté à s'inscrire pour obtenir de l'aide sur des tâches spécifiques. Exemples:
- @ChenPCoder, heureux d'examiner les demandes d'extraction des documents
Coordonnées
- Les rédacteurs techniques qui souhaitent travailler sur ce projet doivent envoyer un e-mail à l'adresse email@project. Veuillez inclure des liens vers vos travaux de rédaction technique ou votre portfolio/CV.
Project Idea: 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 de vous aider à régler le problème, mais nous avons besoin de quelqu'un pour nous organiser et effectuer le correctif.
Comment mesurer le succès ?
- Nombre de problèmes liés à la documentation clôturés
- Augmentation du nombre de contributions à la documentation et du nombre de nouveaux contributeurs
De quelles compétences un rédacteur technique doit-il disposer pour travailler sur ce projet ?
- Bon à avoir:vous savez comment exécuter un correctif de documentation.
- Excellentes compétences organisationnelles
Bénévoles
Encouragez les membres de la communauté à s'inscrire pour obtenir de l'aide sur des tâches spécifiques. Exemples:
- @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 qui souhaitent travailler sur ce projet doivent envoyer un e-mail à l'adresse email@project, ouvrir un problème ou poser une question sur notre forum. Veuillez inclure des liens vers vos travaux de rédaction technique ou de portfolio.
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 prioriser l'amélioration 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 de nombreux 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é
- Baisse du nombre de pages de documentation obsolètes ou incorrectes
De quelles compétences un rédacteur technique doit-il disposer pour travailler sur ce projet ?
- Bénéfique:expérience de l'audit de documents
Bénévoles
Encouragez les membres de la communauté à s'inscrire pour obtenir de l'aide sur des tâches spécifiques. Exemples:
- @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 qui souhaitent travailler sur ce projet doivent envoyer un e-mail à l'adresse email@project, ouvrir un problème ou poser une question sur notre forum. Veuillez inclure des liens vers vos travaux de rédaction technique ou de portfolio.
Informations connexes
- La page Promotion et presse inclut des logos et d'autres contenus que vous pouvez utiliser lorsque vous parlez de Season of Docs.
- Cette vidéo de PyCon Australia 2017 donne des conseils sur l'organisation de votre documentation de manière à ce que les utilisateurs la trouvent utile : Ce que personne ne vous dit sur la documentation de Daniele Procida.