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:
- quafféine
- Nom du projet:
- Guide en ligne LibreOffice: un guide semblable à ceux utilisés pour d'autres applications LO, afin d'inclure non seulement l'utilisation, mais aussi l'installation et l'administration.
- Durée du projet:
- Durée standard (3 mois)
Project description
Si ma candidature est retenue, je prévois de passer huit à dix heures par semaine à rédiger de nouveaux contenus, ainsi qu'à modifier et réutiliser le contenu existant du guide pour créer le guide LibreOffice Online (LOOL). Au rythme que j'écris habituellement et y consacrer entre huit et dix heures par semaine, je m'attendrais à produire un guide d'environ 200 pages ou plus.
J'utilise ces applications depuis StarOffice et je connais bien les fonctionnalités avancées des versions de bureau, notamment:
- Styles dans les applications
- Maîtriser les concepts de documents, de références croisées, de figures et de PAO dans Writer
- Tableaux, graphiques et outils d'analyse de données dans Calc
- Fonctionnalités de présentation interactives, telles que les transitions et les animations dans Impress
J'ai beaucoup utilisé ces versions de bureau, à la fois au travail et pendant mon temps libre.
Ce guide s'adresse aux utilisateurs à mi-parcours techniques, car il s'agit probablement des personnes qui ont les compétences, la patience et surtout, le plus important, pour la mise en route de la musique LOOL. En tant que référence, il s'agirait bien entendu d'un contenu pédagogique simple (comment mettre en gras une sélection de texte, par exemple), mais il faudrait comprendre certains concepts techniques (c'est-à-dire qu'un serveur Web est responsable de la diffusion de l'application sur un navigateur).
Du point de vue de la planification, j'envisagerais, dès le début, le projet en respectant le calendrier suivant, détaillé ci-dessous. Remarque: L'ordre dans lequel je rédige les chapitres n'implique pas nécessairement leur emplacement dans le guide final.
Semaine 1: commencer à explorer les instructions d'installation, tester différentes méthodes d'installation, explorer l'application
L'objectif de cette semaine sera d'avoir une installation fonctionnelle de LOOL. D'après mon expérience, découvrir tous les nombreux petits "moments de découverte !" liés à la documentation de ces types d'applications demande beaucoup de temps. Je serais prêt à les étudier cette semaine afin de pouvoir installer facilement l'application en utilisant n'importe quelle méthode disponible, sans me laisser prendre trop de temps.
Semaine 2: procéder à des installations de référence, méthodes d'installation des documents
Cette semaine sera l'occasion de passer à la préparation d'une liste approximative d'instructions d'installation (non pas entièrement écrites, mais plutôt "en chiffres") et d'un certain nombre de notes à inclure dans les prochains chapitres.
Semaine 3: Rédiger les chapitres de la préface - Préface, introduction, À propos de ce guide, etc.
L'objectif de cette semaine sera d'avoir un ou plusieurs chapitres complets et soignés contenant toutes les informations pertinentes dont le lecteur a besoin avant de procéder à l'installation proprement dite.
Semaine 4: Écrire les chapitres d'installation, partie 1
L'objectif de cette semaine est d'obtenir des instructions d'installation complètes et soignées pour certaines des méthodes disponibles, au format standard des chapitres du guide LibreOffice, mais dans un format qui pourrait facilement être réutilisé par exemple pour le wiki.
Semaine 5: Écrire les chapitres d'installation, partie 2
L’objectif de cette semaine est des instructions d’installation complètes et soignées pour les méthodes restantes, au format standard des chapitres du guide LibreOffice, mais dans un format où elles pourraient facilement être réutilisées, par exemple pour le wiki.
Semaine 6: Écrire un chapitre de configuration post-installation
L'objectif de la semaine est la configuration des chapitres terminés et peaufinés de la configuration post-installation, tels que la définition des préférences de l'application (par exemple, le fuseau horaire), la configuration des utilisateurs et d'autres préparatifs devant être effectués par un administrateur avant la mise en production du système.
Semaine 7: écrire des chapitres concernant la navigation, l'interface et la gestion des fichiers
L'objectif de cette semaine sera des chapitres complets et peaufinés qui, une fois lus, permettront au lecteur de se familiariser avec l'interface utilisateur.
Semaine 8: Rédaction de chapitres (traitement de texte)
Cette semaine, vous devriez voir des chapitres complets et peaufinés qui permettront à l'utilisateur de créer des documents joliment stylisés directement dans l'application.
Semaine 9: écrire le ou les chapitres de calcul (feuille de calcul)
Chapitres complets et soignés permettant à un utilisateur de créer des feuilles de calcul fonctionnelles comprenant la sélection de formules et de graphiques/graphiques pris en charge, l'objectif de cette semaine.
Semaine 10: Écrire une impression (présentation) chapitre(s)
L'objectif de cette semaine sera un ou plusieurs chapitres complets et peaufinés permettant à un utilisateur de créer une présentation interactive avec la possibilité d'en générer une pour la consommation hors ligne ainsi que pour une présentation en direct.
Semaine 11: Écrire des chapitres d'intégration
L'objectif de la semaine 11 est atteint, avec des chapitres peaufinés qui donnent à l'utilisateur une image complète des options d'intégration disponibles. Les conseils spécifiques à l'intégration des applications se présenteraient généralement sous la forme de liens vers des ressources pertinentes, telles que les pages wiki de Document Foundation et/ou les projets intégrés.
Semaine 12: assembler divers éléments (annexes, indices, tableaux de figures, etc.) 1re rédaction/relecture
À la fin de cette semaine, vous devriez trouver un guide complet avec un contenu presque final et des éléments intacts/de travail tels que des références croisées.
Semaine 13: 2e passe, modification/relecture, vérification du type/de la mise en page, envoi
Au cours de cette dernière semaine, nous allons publier un guide complet et final, édité à la fois pour le contenu et la présentation.