La documentation réussie projette - la partie 2 de 3 - la « indication »

Ainsi vous êtes responsable de contrôler un projet de documentation. Vous savez de qui votre assistance est, de ce qu'elles essayent de réaliser, de comment le produit leur permet de le réaliser, et de ce que l'assistance a besoin de l'aide. Maintenant il est temps à Spéc. dehors vos intentions.

NOTE : C'est la seconde dans une série de trois articles décrivant les éléments principaux d'un bon processus de documentation d'utilisateur. (Pour lire les premiers et troisième articles de cette série, aller à http://www.divinewrite.com/docoprocess1.htm et à http://www.divinewrite.com/docoprocess3.htm.)

Énoncer vos buts

Génériquement parlant, votre rapport de but devrait indiquer que vous espérez créer une suite des produits de documentation qui répondront à des exigences d'assistances. Spécifiquement, vous aurez un certain nombre de secondaire-buts. (TIP : Il peut aider à se rappeler que les objectifs que vous fixez ici devront être employés pour mesurer le succès de votre produit par votre propre essai interne aussi bien que la recherche évaluative traversante d'utilisateur.) de tels secondaire-buts peuvent inclure :

• Facilité d'utilisation
• Accessibilité
• Utilité
• Exactitude
• Pertinence
• Globalité
• Adhérence pour dénommer des directives
• Épellation et ponctuation correctes

Écrire vos caractéristiques de concept

Vos buts placent, vous peuvent commencer contemplent ce que vous allez produire. La première étape est de créer quelques caractéristiques de concept. Simplement mises, Spéc. de concepts sont des vues d'ensemble très à niveau élevé de ce que vous proposez de produire. Par exemple, votre Spéc. de concept pour l'aide en ligne pourrait déclarer que vous produirez un produit qui permet à l'utilisateur d'accéder à l'information en utilisant un COT, un index, et une trouvaille. Elle pourrait suggérer quelques dispositifs possibles de GUI de ces éléments, mais elle n'établira pas des conditions ; possibilités justes. Spéc. de concept pour vos manuels pourrait déclarer qu'elles seront regarder professionnel, contiendra beaucoup d'images professionnellement dessinées, aura à espace blanc proportionné, sera élégante, sera divisée en chapitres au match la nature adaptée à la tâche de l'aide, etc. en ligne.

Généralement, le produit que vous proposez pourrait être mis en application d'un certain nombre de différentes manières. Vous devriez écrire une ou plusieurs Spéc. de concept pour :

• de quels composants la suite de documentation se composera (aide en ligne, manuels imprimés, cours d'instruction, vues d'ensemble, etc.) - « des spécifications de concept de produits de documentation »
• les types d'information que votre documentation contiendra (par exemple, la structure du COT, sont vous allant suivre des pratiques en matière de minimalisme ?) - « Spécifications contentes de concept de documentation »
• la fonctionnalité et l'interface utilisateur de votre suite de documentation (par exemple, comment cela fonctionnera et comment les assistances agiront l'un sur l'autre avec elle) - « spécifications en ligne de concept d'interface utilisateur d'aide », « ont imprimé des spécifications de concept d'interface utilisateur de documentation », etc.
• la méthode de la livraison (comment vous fournirez l'aide aux utilisateurs et comment vous la mettrez à jour)
• quelles langues la documentation sera produit dedans

Concevoir quelques réalisations possibles

Maintenant que vous avez décidé rudement ce que vous voudriez produire, vous pouvez concevoir quelques réalisations possibles de lui. Vos conceptions seront très à niveau élevé et elles peuvent réellement ne pas fonctionner (elles peuvent réellement être les prototypes de papier justes).

Avec la plupart des autres considérations a déjà mené à bonne fin par votre recherche d'exigences d'utilisateur, ces réalisations devrait seulement différer en raison de :

• les technologies derrière elles
• les outils les créaient
• le regard et la sensation globaux

Vous devez se renseigner autant que possible sur ces choses, afin de déterminer ce qui est réellement possible, réussi, efficace, etc. Vous devriez se rendre compte des tendances courantes, de la littérature, des livres blancs, etc. Cette information peut être obtenue à partir d'une variété de sources. Quelques bons endroits à commencer à inclure :

• Gestionnaires Listserv
• Conférences
• Livres
• D'autres publications
• D'autres auteurs
• D'autres produits

Rentabilité de conduite examinant sur vos prototypes

Modeler (prototype) vos conceptions pour les échantillons de décideurs et d'assistances. Ceci te permet de sélectionner les meilleurs dispositifs de chaque conception (et pour déterminer des priorités pour elles). Choisir une conception (ou fusionner les conceptions multiples) cette vous croient répond mieux à des exigences d'utilisateur. Ce processus peut être itératif. À la fin de cette étape, vous devriez savoir assez pour détailler exactement ce que vous produirez (quelle plateforme y compris d'aide et vous usinent emploiera).

TIP : Pour des détails sur des méthodes possibles de recherches, jeter un coup d'oeil à contrôler vos projets de documentation par Hackos (1994) en particulier pp.446-447, utilisateur et l'analyse des tâches pour la conception d'interface par Hackos et Redish (1998), vente sociale : Nouvel impératif pour la santé publique par Manoff (1985), concevant la 22eme édition de recherches qualitatives par le maréchal et le Rossman (1995), et « conduisant les groupes de foyer - un guide pour les utilisateurs pour la première fois », dans l'intelligence de vente et projetant par Tynan et Drayton (1988).

Écrire vos caractéristiques de conditions

Les caractéristiques de conditions détaillent exactement avec ce que vous devez finir vers le haut. Ces caractéristiques devraient contenir autant détail comme possible au sujet des dispositifs et de la fonctionnalité du produit de documentation (pas comment vous aborderez le bâtiment il).

Spéc. de conditions sont fondamentalement une évolution de vos Spéc. de concept. Une fois que vous commencez le travail sur vos Spéc. de conditions, Spéc. de concept sont efficacement gelées. Vous devriez écrire une ou plusieurs Spéc. de concept pour :

• de quels composants la suite de documentation se composera (aide en ligne, manuels imprimés, cours d'instruction, vues d'ensemble, etc.) - « des spécifications de conditions de produits de documentation »
• les types d'information que votre documentation contiendra (par exemple, la structure du COT, sont toi allant suivre des pratiques en matière de minimalisme ?) - « Spécifications de conditions contentes de documentation »
• la fonctionnalité et l'interface utilisateur de votre suite de documentation (par exemple, comment cela fonctionnera et comment les assistances agiront l'un sur l'autre avec elle) - « spécifications de conditions en ligne d'interface utilisateur d'aide », « ont imprimé des spécifications de conditions d'interface utilisateur de documentation », etc.
• la méthode de la livraison (comment vous fournirez l'aide aux utilisateurs et comment vous la mettrez à jour)
• quelles langues la documentation sera produit dedans

Durée et ressources de projet d'évaluation

Une fois que vous avez accompli l'étape de Spéc. de conditions, vous devriez savoir assez pour estimer exactement les conditions de durée et de ressource pour le reste du projet. Vous devriez également mettre à jour le document « de plan de projet de documentation » avec cette information.

Estimer est toujours un processus difficile, et il n'y a pas vraiment aucune manière du sûr-feu de l'obtenir droite. La plupart du temps elle dépend du travail et de votre expérience. Cependant, suivantes sont quelques directives qui pourraient vous aider.

Si vous avez des disques des projets précédents, vous pourriez simplement pouvoir estimer la durée de projet basée sur ces derniers. Vous devriez essayer de comparer le vieux matériel et matières soumis au nouveau pour s'assurer que les vieux temps seront applicables au nouveau projet. Sur p.174 de contrôler votre documentation Projects (1994), Hackos fournit quelques directives potentiellement utiles pour comparer la complexité de divers projets de documentation.

Si, d'une part, le projet est entièrement nouveau, vous n'aurez aucun disque à employer comme guide (à moins que vous avez contrôlé un projet semblable dans le passé). Dans cette situation, il sera très difficile faire des évaluations de projet.

Une méthode possible pour estimer est :

1. Compiler une liste de charge, et enregistre combien là sont dans votre liste.
2. Compiler une liste de concepts qui doivent être documentés, et enregistrer combien là sont dans votre liste.
3. À partir de votre liste de charge, choisit 10 qui sont représentant du repos (en termes de complexité, prévu longueur, le statut du développement approprié, etc.), et du même granularity (par exemple, vous pouvez écrire une matière simple pour chacun).
4. À partir de votre liste de concepts, choisir 3 qui sont représentant du repos, et du même granularity (par exemple, vous pouvez écrire une matière simple pour chacun).
5. Estimer le nombre de pages par matière.
6. Documenter ces derniers charge et des concepts comme épreuve, en s'assurant que vous dépistez :

   • tout le temps pris pour accomplir chaque matière.
   • la partie de ce temps qui était dû au changement ou à l'indécision de produit.
   • le nombre de pages par matière.
   • le nombre de supplémentaire, inattendu, mais nécessaire, des matières vous vous êtes rendus compte de en raison de la documentation. Garder un disque séparé du nombre pour tous les deux pour charger et des matières conceptuelles.

   TIP : Tirer le meilleur de votre doco d'essai. Quoique vous ayez choisi une conception par le prototypage de conception, vous pouvez employer votre échantillon de documentation pour examiner la rentabilité de votre approche de documentation. En présentant l'échantillon à un échantillon d'assistances, vous pouvez déterminer si vous vous dirigez dans la bonne direction avec votre doco (c.-à-d. si vous avez interprété et avez mis en application vos résultats de la recherche d'utilisateur correctement).

7. Déterminer le moment moyen pris par la page pour chargent et pour des matières conceptuelles.
8. Appliquer cette moyenne au reste des matières dans le projet. (Matières écrites tôt dans la prise de projet normalement plus longtemps due au manque d'information et de nombre plus élevé de questions techniques. Ceci signifie que les matières écrites plus tard dans le processus prendront probablement moins que la moyenne calculée ici. Cependant, ceci sera normalement compensé par les changements supplémentaires de produit de temps encourra pendant le cycle de vie de projet.)
9. Estimer le temps par domaine basé sur le temps moyen par matière.
10. Estimer le nombre de supplémentaire, inattendu, les matières qui deviendront probablement nécessaires pendant le reste du projet.
11. Tenir compte de la formation, de l'entretien de prac de travail, des vacances, des jours en difficulté, des réunions, de la rentabilité examinant, de la production (délais d'approximativement 6 semaines pour imprimer un manuel de 1000 pages, y compris l'imperméabilisation), de l'évaluation, et de l'essai évaluatif. Chacun de ces éléments changera selon la nature du projet, et ils tendront à prendre loin moins de temps que l'écriture réelle. C'est pourquoi des directives spécifiques ne sont pas fournies pendant qu'elles sont pour l'inscription.

Figure dehors combien de temps vous réellement devez le faire, puis combien d'auteurs vous devront l'obtenir fait pendant ce temps. Élaborer un programme de projet en utilisant quelque chose comme le projet de Microsoft, en identifiant les étapes importantes et les dates-limites utiles de projet. Certaines de vos étapes importantes pourraient inclure :

• Essai de prototype complet
• Travail Pracs écrit
• Spéc. de conception écrites
• Première ébauche complète
• Deuxième ébauche complète
• Localisation de la deuxième ébauche complète
• Projet définitif complet
• Localisation complète
• Documentation prête pour le dégagement
• Production complète
• Évaluation de projet complète
• Poteau-libérer l'essai de rentabilité complet

Il est important de noter que vous aurez des étapes importantes avant ce point, mais parce qu'ils se produisent avant l'étape de établissement du programme formelle, ils n'ont pas besoin d'être inclus dans ce programme.

Écrire le travail Pracs et concevoir Spéc.

Avec la recherche d'utilisateur, les pracs de travail et les Spéc. de conception sont peut-être les éléments de projet les plus faciles à donner sur, particulièrement pour une petite équipe. Cependant, même chez de petites équipes, il est utile de maintenir tous les deux.

Les pracs de travail sont pour des choses continues, celle affectent l'environnement de fonctionnement quotidien de l'équipe (par exemple, comment utiliser votre outil de documentation, comment libérer votre aide, un guide de modèle, etc.). Spéc. de conception sont pour documenter des choses uniques comme la façon dont nous projetons réellement aborder cette chose. Ceci inclura une telle information que quels outils nous utiliserons, ce qui chacun fera, et les mécanismes de la façon dont elle toute va ensemble. par exemple, comment le projet de VSS fonctionnera, comment tout devrait être contrôlé, les questions à utilisateurs multiples, comment il sera localisé, etc.

Être continué… Voir la partie 3 de cet article (http://www.divinewrite.com/docoprocess3.htm) pour l'information sur écrire votre documentation d'utilisateur.