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:
- moja global
- Rédacteur technique:
- Antoine
- Nom du projet:
- Documentation sur le code de l'outil de signalement
- Durée du projet:
- Durée standard (3 mois)
Project description
Étant donné la possibilité de présenter l'outil de création de rapports pour l'organisation Moja Global, je propose de développer six types de documentation qui seront utilisés par différents publics à des fins différentes. Celles-ci sont résumées ci-dessous:
1) Guide de configuration de l'environnement
1.1) Audience cible Ingénieurs système
1.2) Objectif Aidez les ingénieurs système à configurer un environnement local de compilation et d'exécution pour l'outil de création de rapports.
1.3) Mettre en forme Un article de guide qui prescrit l'ensemble des étapes séquentielles que les ingénieurs système doivent suivre pour configurer l'environnement propice à la création et à l'exécution de l'outil de création de rapports.
2) Guide de création
2.1) Audience cible Ingénieurs système
2.2) Objectif Aider les ingénieurs système à créer les composants de l'outil de création de rapports à partir du code source
2.3) Mettre en forme Un article de guide qui prescrit l'ensemble des étapes séquentielles que les ingénieurs système doivent suivre pour obtenir et compiler le code source de l'outil de création de rapports.
3) Guide d'installation
3.1) Audience cible Ingénieurs système
3.2) Objectif Aider les ingénieurs système à installer les derniers composants de l'outil de création de rapports
3.3) Mettre en forme Un article de guide qui indique l'ensemble des étapes séquentielles que les ingénieurs système doivent suivre pour déployer l'outil de création de rapports dans un environnement nouvellement configuré.
4)Guide d'utilisation
4.1) Audience cible Intégrateurs de systèmes
4.2) Objectif Aider les ingénieurs système à exécuter une nouvelle instance de l'outil de création de rapports
4.3) Mettre en forme Un article de procédure qui prescrit l'ensemble des étapes séquentielles que les intégrateurs système doivent suivre pour importer et traiter des bases de données de sortie de flux sur une instance d'outil de création de rapports en cours d'exécution.
Guide d'utilisation Intégrer et traiter les bases de données de sortie du flux dans l'outil de création de rapports
5) Guide de l'utilisateur
5.1) Audience cible Utilisateurs finaux
5.2) Objectif Aider les Utilisateurs finaux à comprendre les différentes fonctionnalités intégrées à l'Outil de signalement et leur utilisation.
5.3) Mettre en forme Un article descriptif qui prescrit l'ensemble des étapes séquentielles que les Utilisateurs finaux doivent suivre pour utiliser correctement les Fonctionnalités de l'Outil de création de rapports.
6) Guide de développement
6.1) Programmeurs cibles
6.2) Objectif Aider les Utilisateurs finaux à comprendre les différentes fonctionnalités intégrées à l'Outil de signalement et leur utilisation.
6.3) Mettre en forme Articles de référence décrivant : a) les principaux éléments de conception qui composent l'outil b) la décomposition fonctionnelle des éléments ci-dessus c) les éléments d'exécution des éléments fonctionnellement décomposés d) l'organisation du code source / des bibliothèques de l'outil e) la vision à long terme et la direction d'amélioration continue f) les prochains domaines d'amélioration logiques
Un bref tutoriel expliquant comment ajuster le code en fonction des circonstances spécifiques de l'utilisateur