Cette page contient les détails d'un projet de rédaction technique accepté pour la saison des documents Google.
Résumé du projet
- Organisation Open Source:
- moja international
- Rédacteur technique:
- Anthony
- Nom du projet:
- Documentation sur le code de l'outil de création de rapports
- Durée du projet:
- Durée standard (trois mois)
Project description
Ayant l'opportunité de documenter l'outil de reporting de l'entreprise Moja Global, je propose de développer six types de documentation qui seront utilisés par différentes audiences à des fins différentes. Ils sont résumés ci-dessous:
1) Guide de configuration de l'environnement
1.1) Audience cibleIngénieurs système
1.2) Objectif Aider 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) Format Article de procédure qui décrit l'ensemble d'é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 compilation
2.1) Audience cible Les ingénieurs système
2.2) ObjectifAider les ingénieurs système à créer les composants de l'outil de création de rapports à partir du code source
2.3) Format Guide pratique qui décrit les é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 cibleIngénieurs système
3.2) Objectif Aider les ingénieurs système à installer de nouveaux composants de l'outil de création de rapports
3.3) Format Article de procédure qui décrit l'ensemble d'étapes séquentielles que les ingénieurs système doivent suivre pour déployer l'outil de création de rapports dans un environnement fraîchement configuré.
4) Guide d'utilisation
4.1) Audience cible Intégrateurs système
4.2) ObjectifAider les ingénieurs système à exécuter une instance de l'outil de création de rapports récemment installée
4.3) FormatArticle de procédure qui décrit l'ensemble d'é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 reporting en cours d'exécution.
Guide d'utilisation Intégration et traitement des bases de données de sortie Flux dans l'outil de création de rapports
5) Guide de l'utilisateur
5.1) Audience cible : utilisateurs finaux
5.2) ObjectifAidez les utilisateurs finaux à comprendre les différentes fonctionnalités intégrées à l'outil de création de rapports et à savoir comment les utiliser.
5.3) Format Article de procédure qui décrit l'ensemble d'étapes séquentielles que les utilisateurs finaux doivent suivre pour utiliser correctement les fonctionnalités de l'outil de reporting.
6) Guide de développement
6.1) Audience cible : programmeurs
6.2) ObjectifAidez les utilisateurs finaux à comprendre les différentes fonctionnalités intégrées à l'outil de création de rapports et à savoir comment les utiliser.
6.3) Format Articles de référence qui décrivent : a)les principaux éléments de conception qui constituent l'outil b)la décomposition fonctionnelle des éléments ci-dessus c)les éléments d'exécution des éléments décomposés fonctionnellement d)l'organisation du code source / des bibliothèques de l'outil e)la vision et l'orientation à long terme pour l'amélioration continue f)les prochaines zones d'amélioration logiques
et un bref tutoriel expliquant comment adapter le code aux circonstances spécifiques de l'utilisateur.