L'équipe de documentation recherche des super-héros
Auteurs : Sarah McCarthy
Traduit par : Léo - W-Seils
Une documentation claire et fiable donne du pouvoir aux utilisateurs, accueille les nouveaux venus et garantit un succès à long terme. L’équipe de documentation TYPO3 fait appel aux membres de la communauté pour aider à améliorer et à développer la documentation. Chaque contribution, petite ou grande, fait la différence.
Le fondement de notre communauté
Une bonne documentation logicielle est essentielle car elle favorise le partage des connaissances au sein de la communauté. Lorsqu'elle est claire et fiable, elle réduit les obstacles pour les nouveaux utilisateurs et contribue à la croissance de la communauté. Elle permet également d'approfondir les compétences des utilisateurs existants, les rendant plus indépendants et plus confiants. Une documentation de haute qualité est donc essentielle au succès global de TYPO3.
TYPO3 est un logiciel open source, la rédaction de la documentation relève donc de la responsabilité de la communauté. L'équipe de documentation TYPO3 coordonne les contributions et assure la maintenance des documents, mais elle est petite et il y a toujours beaucoup à faire.
Nous avons besoin de votre aide
Nous avons un besoin urgent de contributeurs supplémentaires ! Si vous avez déjà lu la documentation TYPO3 et pensé que quelque chose ne semblait pas tout à fait correct ou qu'elle aurait pu être rédigée de manière plus utile, pensez à contribuer. Vous pouvez apporter des corrections linguistiques ou des corrections de code. Nous sommes reconnaissants pour toute contribution, aussi minime soit-elle.
Ce sur quoi nous travaillons
Au cours de l'année, l'équipe de documentation se concentre sur des projets spécifiques. Actuellement, nous travaillons sur :
- Comment créer des extensions
- Déployer et exécuter TYPO3 dans Docker
- Clarifier les modes Classic et Composer
Nous améliorons également la référence ViewHelper afin de la rendre plus accessible aux intégrateurs et aux développeurs. Toute aide de la part d'intégrateurs expérimentés dans Fluid serait particulièrement appréciée à cet égard.
Comment contribuer
Si vous souhaitez contribuer mais ne savez pas comment, un moyen simple de commencer est d'utiliser le bouton « Modifier sur GitHub » situé dans le coin supérieur droit de toute page de documentation. Cela créera une fourche du dépôt. Après avoir effectué vos modifications, ajoutez un commentaire et enregistrez pour terminer la validation. L'équipe de documentation vérifiera toutes les modifications que vous apporterez, vous n'avez donc pas à vous inquiéter de causer des dommages. Vous pouvez également consulter notre guide complet destiné aux contributeurs, Comment documenter TYPO3.
Impliquez-vous
L'équipe de documentation organise une réunion mensuelle sur le canal Slack #typo3-documentation. Nous organisons également des sessions de documentation en direct auxquelles tout le monde peut participer et apporter son aide. Nous serions ravis de vous y voir !