Cette page contient les détails d'un projet de rédaction technique accepté pour 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 sur les fonctions de Calc
- Durée du projet:
- Durée standard (3 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 dans la phase de pré-rédaction afin d’acquérir les compétences requises pour le projet. Je tiens à vous informer que je vis actuellement dans mon université(dans mon pays d’origine), où j’ai accès à l’Internet rapide et à toute ressource complémentaire nécessaire pour le projet. Je continuerai de mon université elle-même pendant toute la durée du projet, car nous sommes en situation de COVID-19. Mon université ne devrait pas bientôt commencer, et même si c’est le cas, je n’aurai pas d’incidence sur mon projet de dernière année où je ne suis censé suivre des cours que pendant une semaine.
INTRODUCTION
LibreOffice Calc dispose d'une longue liste (plus de 500) de fonctions dans de nombreuses catégories pour lesquelles la documentation est assez superficielle (mais néanmoins précise) dans l'aide. L'assistant de fonction intégré à Calc fournit également à l'utilisateur des informations récapitulatives sur la fonction et les paramètres de chaque fonction. Une structure a été créée sur le wiki de The Document Foundation afin de capturer des informations de référence plus détaillées sur les fonctions de Calc.
OBJECTIF
Pour renseigner la structure wiki en écrivant un contenu plus détaillé 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, en donnant un ou deux exemples pour indiquer les cas particuliers et les exceptions, et en fournissant des exemples de fichiers.
PLAN DE TRAVAIL DU PROJET
J'ai suivi en détail l'idée de base du projet et nous essayons essentiellement de documenter le fonctionnement de chaque fonction dans l'assistant des fonctions et avec suffisamment d'exemples pour chacune d'elles couvrant tous les aspects des fonctions. Nous essayons de rendre la documentation aussi intuitive que possible pour qu'un nouvel utilisateur puisse le consulter et comprendre en quelques secondes comment l'utiliser.
J'envisagerais de diviser ces fonctions par 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 a environ 20 à 50 fonctions, avec peu de catégories ayant plus. La plupart d’entre elles comprennent une description superficielle avec une syntaxe et un exemple.
Je voudrais ajouter un contenu plus détaillé pour chacune des fonctions de Calc, signaler le respect de la norme ODFF, y compris des illustrations et diagrammes lorsque cela est utile, donner un ou deux exemples pour indiquer les cas particuliers et les exceptions sous forme de remarques, et fournir des exemples de fichiers. Ajoutez également une section importante si nécessaire. Je vais envisager d'utiliser ces fonctions sous forme catégorielle, c'est-à-dire d'en sélectionner une et de travailler verticalement, puis de passer à une autre catégorie pendant la période de rédaction technique. En outre, j'envisagerais de m'habituer à l'environnement de travail pendant la période de cohésion communautaire pour faciliter les choses pendant la phase de rédaction. D'après mon expérience, découvrir toutes les nombreuses petites étapes de la documentation de ces types d'applications demande un investissement en temps. En ce qui concerne la planification, j'aborderais le projet au départ en parcourant ces 11 catégories sur lesquelles travailler, bien sûr, certaines auront besoin de plus d'aide et donc nécessitent plus de temps que d'autres, mais ces choses peuvent être traitées en travaillant. Comme il existe déjà de la documentation et que j'écris dessus, j'envisagerai de la relire après la tâche de chaque semaine, car il n'est pas bon de les laisser la semaine dernière.
Vous trouverez ci-dessous un calendrier approximatif pour organiser le projet dans les limites de temps.
- Semaine 1:(14 septembre) • Base de données
- Semaine 2:(21 septembre) • Date et heure
- Semaine 3:(28 septembre) • Finances
- Semaine 4:(5 oct) • Informations
- Semaine 5:(12 oct) • Logique
- Semaine 6:(19 octobre) • Mathématiques
- Semaine 7:(26 oct.) • Tableau
- Semaine 8:(2 nov.) • Statistiques
- Semaine 9:(9 novembre) • Feuille de calcul
- Semaine 10:(16 novembre) • Texte
- Semaine 11:(23 novembre) • Complément
- Semaine 12:(30 nov. – 5 déc.)(finale)
La documentation du travail effectué et de l'expérience acquise dans ce projet et des tâches mineures comprenaient la relecture/modification d'une deuxième étape si nécessaire pour préparer la documentation à l'envoi.