Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- LibreOffice
- Rédacteur technique:
- Krezhairo
- Nom du projet:
- Documentation de référence et guide de l'utilisateur des fonctions Calc
- Durée du projet:
- Durée standard (trois mois)
Project description
DEMANDE DE PROJET
Je peux facilement consacrer 30 à 35 heures par semaine pendant la phase de rédaction technique et 10 à 12 heures pendant la phase de pré-rédaction pour apprendre les compétences supplémentaires nécessaires au projet. Je tiens à vous informer que je vis actuellement dans mon université(dans mon pays d'origine), où j'ai accès à une connexion Internet rapide et à toutes les ressources complémentaires nécessaires au projet. Je vais travailler depuis mon université pendant toute la durée du projet. Étant donné que nous sommes dans la situation du COVID-19, je ne vois pas mon université reprendre de sitôt. Et même si c'était le cas, je serais en dernière année, où je ne suis censé suivre des cours que 5 à 6 heures par semaine. Cela n'affectera donc pas le projet.
INTRODUCTION
LibreOffice Calc dispose d'une longue liste de fonctions (+ 500) dans de nombreuses catégories pour lesquelles la documentation est relativement superficielle (mais néanmoins précise) dans l'aide. L'assistant de fonctions intégré à Calc fournit également à l'utilisateur des informations récapitulatives sur l'objectif et les paramètres de chaque fonction. Une structure a été créée sur le wiki de la Document Foundation pour capturer des informations de référence plus détaillées sur les fonctions de Calc.
OBJECTIF
Pour renseigner la structure du wiki en rédigeant des contenus plus détaillés pour chacune des fonctions de Calc, il a été utile de signaler le respect de la norme ODFF, y compris des illustrations et des diagrammes, de donner un ou deux exemples pour indiquer les cas particuliers et les exceptions, et de fournir des fichiers d'exemple.
PLAN DE TRAVAIL DU PROJET
J'ai examiné en détail l'idée de base du projet. Nous essayons essentiellement de documenter le fonctionnement de chaque fonction dans l'assistant de fonctions, ainsi que des exemples suffisants pour chacune d'entre elles, couvrant tous les aspects des fonctions. Nous essayons de rendre la documentation aussi intuitive que possible afin qu'un nouvel utilisateur puisse la consulter et comprendre comment l'utiliser en quelques secondes.
Je vous propose de diviser ces fonctions en catégories:
• Database: This section deals with functions used with data organized as one row of data for one record.
• Date & Time: These spreadsheet functions are used for inserting and editing dates and times.
• Financial: This category contains the mathematical finance functions of LibreOffice Calc.
• Information: This category contains Information functions.
• Logical: This category contains Logical functions.
• Mathematical: This category contains the Mathematical functions for Calc.
• Array: This category contains the array functions.
• Statistical: This category contains Statistics functions.
• Spreadsheet: This section contains descriptions of the Spreadsheet functions together with an example.
• Text: This section contains descriptions of the Text functions.
• Add-in: The following describes and lists some of the available add-in functions.
Chacune d'entre elles comporte environ 20 à 50 fonctions, et quelques catégories en possèdent davantage. La plupart d'entre eux incluent une description superficielle avec la syntaxe et un exemple.
Je voudrais ajouter des contenus plus détaillés pour chacune des fonctions de Calc, en signalant le respect de la norme ODFF, en incluant des illustrations et des diagrammes lorsque cela est utile, en donnant un ou deux exemples pour indiquer les cas particuliers et les exceptions sous forme de remarques, et en fournissant des fichiers d'exemple. Ajout également d'une section importante partout où c'est utile. Je vais envisager de passer par ces fonctions sous forme de catégories, c'est-à-dire en en choisissant une et en travaillant verticalement, puis en passant à une autre catégorie pendant la période d'écriture technique. En outre, je vous recommande de vous habituer à l'environnement de travail pendant la période de consolidation de la communauté afin de faciliter la phase d'écriture. D'après mon expérience, la découverte de toutes ces informations "compris" dans la documentation de ces types d'applications demande beaucoup de temps. En termes de planification, au départ, j'aborderais le projet en examinant ces 11 catégories à travailler. Bien sûr, certaines nécessiteront plus d'aide et donc plus de temps que d'autres, mais ces éléments peuvent être abordés au cours du travail. Étant donné qu'il existe déjà des documents et que j'écris dessus, je vais envisager de les relire une fois que la tâche de chaque semaine sera terminée, car il n'est pas bon de les laisser pour la dernière semaine.
Vous trouverez ci-dessous un calendrier approximatif pour organiser le projet dans les délais.
- Semaine 1:(14 septembre) • Base de données
- Semaine 2 (21 septembre) • Date et heure
- Semaine 3:(28 septembre) • Finance
- Semaine 4 (5 octobre) • Informations
- Semaine 5 (12 octobre) • Logique
- Semaine 6:(19 oct.) • Mathématique
- Semaine 7 (26 octobre) • Tableau
- Semaine 8:(2 nov.) • Statistique
- Semaine 9 (9 novembre) : • Feuille de calcul
- Semaine 10 (16 novembre) • Texte
- Semaine 11:(23 nov.) • Module complémentaire
- Semaine 12:(30 nov. – 5 déc.)(finale)
La documentation du travail effectué et de l'expérience acquise dans le cadre de ce projet et du travail sur des choses mineures comprenait une deuxième relecture/modification si nécessaire pour préparer la documentation à envoyer.