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: guide semblable à ceux utilisés pour les autres applications LO, qui inclut non seulement l'utilisation, mais aussi l'installation et l'administration.
- Durée du projet:
- Durée standard (3 mois)
Project description
Si votre candidature est retenue, je prévois de passer huit à dix heures par semaine à la rédaction de nouveaux contenus, ainsi qu'à la modification et à la réutilisation du contenu d'un guide existant pour créer le guide LibreOffice Online (LOOL). Au rythme que je rédige habituellement et y consacre entre huit et dix heures par semaine, je prévois de produire un guide d'environ 200 pages ou plus.
J'utilise ces applications depuis le nom de StarOffice et je connais bien les fonctionnalités avancées des versions pour ordinateur de bureau, y compris:
- Styles dans toutes les applications
- Documents de référence, références croisées, chiffres et concepts 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, aussi bien au travail que pendant mon temps libre.
Ce guide s'adresse aux utilisateurs de niveau technique moyen, car il s'agit probablement des personnes qui ont les compétences, la patience et surtout, le plus important, dans la mise en place de solutions comme "LOOL". S'il s'agit d'une référence, il s'agirait bien entendu d'un contenu pédagogique simple (par exemple, comment mettre du texte en gras), mais il faudrait comprendre certains concepts techniques (c'est-à-dire qu'un serveur Web est chargé de diffuser l'application sur un navigateur).
Du point de vue de la planification, j'envisagerais dès le départ le projet selon le calendrier suivant, détaillé ci-dessous. Remarque: l'ordre dans lequel je rédige les chapitres n'indique pas nécessairement leur emplacement dans le guide final.
Semaine 1: découvrir 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 toutes les nombreuses petites étapes de la documentation de ces types d'applications demande un investissement en temps. J'aimerais travailler sur ces outils cette semaine pour pouvoir installer facilement l'application en utilisant n'importe quelle méthode disponible, sans me laisser submerger par ces obstacles.
Semaine 2: Installer les références et les méthodes d'installation des documents
Cette semaine, il faudrait élaborer une liste approximative d'instructions d'installation (pas dans un format entièrement écrit, mais plutôt"par chiffres") et un certain nombre de notes qui seront incluses dans les chapitres suivants.
Semaine 3: Rédaction du ou des chapitres de la préface - Avant-propos, introduction, à propos de ce guide, etc.
L'objectif de cette semaine sera d'avoir un ou plusieurs chapitres complets et peaufinés contenant toutes les informations pertinentes dont le lecteur a besoin avant de se lancer dans 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 une forme où elles pourraient facilement être réutilisées, par exemple pour le wiki.
Semaine 5: Écrire les chapitres d'installation, partie 2
L'objectif de cette semaine est d'obtenir des instructions d'installation complètes et soignées pour les méthodes restantes, au format standard des chapitres du guide LibreOffice, mais dans une forme où elles pourraient facilement être réutilisées, par exemple pour le wiki.
Semaine 6: Chapitre d'écriture de la configuration post-installation
L'objectif de cette semaine est de passer à des chapitres soignés concernant la configuration post-installation, comme la définition des préférences de l'application (par exemple, le fuseau horaire), la configuration des utilisateurs et d'autres préparations qu'un administrateur doit effectuer avant de mettre le système en production.
Semaine 7: Écrire des chapitres relatifs à la navigation, à l'interface et à la gestion des fichiers
Cette semaine se composera de chapitres complets et peaufinés qui, une fois lus, permettront aux lecteurs de se familiariser avec l'interface utilisateur.
Semaine 8: Rédacteur (traitement de texte) chapitre(s)
Cette semaine, vous devriez voir des chapitres complets et soignés permettant à l'utilisateur de créer des documents stylisés directement dans l'application.
Semaine 9: écrire le calcul du ou des chapitres (feuille de calcul)
L’objectif de cette semaine est la sélection de chapitres complets et peaufinés permettant à un utilisateur de créer des feuilles de calcul fonctionnelles, y compris la sélection de formules et de graphiques pris en charge.
Semaine 10: écriture d'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é de la produire pour une consommation hors ligne ainsi que pour une présentation en direct.
Semaine 11: Écrire les chapitres d'intégration
L'objectif de la semaine 11 est atteint. Des chapitres peaufinés fournissent à l'utilisateur une image complète des options d'intégration disponibles. Les conseils spécifiques concernant 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 les éléments divers (annexes, indices, tableaux de chiffres, etc.), Modification/Relecture pour la première étape
À la fin de la semaine, un guide complet devrait être disponible, avec le contenu presque final et des éléments intacts ou opérationnels, tels que des références croisées.
Semaine 13: modification/relecture après la deuxième passe, vérification du type et de la mise en page, envoi
Au cours de cette dernière semaine, nous allons soumettre un guide complet et final, édité à la fois pour le contenu et la présentation.