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 documents qui seront utilisés par différents publics pour atteindre différents objectifs. Celles-ci sont résumées ci-dessous:
1) Guide de configuration de l'environnement
1.1) Public cible Ingénieurs système
1.2) Objectif Les ingénieurs système d'aide à la configuration d'un environnement local de compilation et d'exécution pour l'outil de création de rapports
1.3) Mettre en forme Un guide pratique qui prescrit l'ensemble des étapes séquentielles que les ingénieurs système doivent suivre pour configurer l'environnement qui sera propice à la création et à l'exécution de l'outil de création de rapports.
2) Guide de création
2.1) Public cible Ingénieurs système
2.2) Objectif Les ingénieurs système aident les ingénieurs système à créer les composants de l'outil de création de rapports à partir du code source.
2.3) Format
3)Guide d'installation
3.1) Public cible Ingénieurs système
3.2) Objectif Aider les ingénieurs système à installer les composants nouvellement créés de l'outil de création de rapports
3.3) Mettre en forme Un guide d'utilisation qui décrit 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 instance nouvellement installée de l'outil de création de rapports
4.3) Mettre en forme Un article de guide qui prescrit l'ensemble des étapes séquentielles que les intégrateurs système doivent suivre pour importer et traiter les bases de données de sortie Flux sur une instance de l'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 de 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 création de rapports et leur utilisation.
5.3) Mettre en forme Un Article de guide 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 dans l'Outil de création de rapports 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 l'orientation d'amélioration continue f) les prochaines axes d'amélioration logiques
Un bref tutoriel expliquant comment adapter le code aux circonstances spécifiques de l'utilisateur