Si vous ’ re responsable de la gestion d'un projet de documentation. Vous savez qui est votre public ce qu'ils ’ re tente d'accomplir, comment le produit leur permet d'y arriver, et ce que le public exige de l'aide. Maintenant, il ’ temps de spec sur vos intentions.
NOTE : Ceci est le deuxième d'une série de trois articles décrivant les principaux éléments d'un processus de documentation utilisateur bien. (Pour lire les articles premiers et troisième de cette série, aller à http://www.divinewrite.com/docoprocess1.htm et http://www.divinewrite.com/docoprocess3.htm).
L'état de vos objectifs
Généralement parlant, votre énoncé de but doit indiquer que vous souhaitez créer une suite de produits de documentation qui satisfera les besoins de l'auditoire. Plus précisément, vous ’ ll ont un certain nombre de sous-objectifs. (Astuce : il peut être utile de se rappeler que les objectifs que vous définissez ici devront être utilisés pour mesurer le succès de votre produit par vos propres tests internes ainsi que par la recherche évaluative utilisateur.) Ces objectifs peuvent inclure :
• Facilité d'utilisation
• L'accessibilité
• Serviabilité
• Précision
• Pertinence
• Exhaustivité
• Respect des règles de style
Ponctuation et orthographe correcte •
Écrire des spécifications de votre Concept
L'ensemble de vos objectifs, vous pouvez commencer à contempler ce que vous ’ re va produire. La première étape consiste à créer des spécifications de concept. En termes simples, spécifications de concepts sont des aperçus de niveau très élevés de ce que vous ’ re propose de produire. Par exemple, vos spécifications de concept pour l'aide en ligne pourraient énoncer que vous produirez un produit qui permet à l'utilisateur d'accéder aux informations à l'aide d'une table des matières, un Index et une découverte. Il pourrait suggérer certaines fonctions GUI possibles de ces éléments, mais il ne sera pas définir des conditions ; quelques possibilités. La spécification de concept pour vos manuels pourrait état qu'ils seront professionnels à la recherche, contient plusieurs images professionnellement dessinées, aura suffisamment d'espace blanc, élégante, sera divisée en chapitres pour correspondre à la nature de la tâche orientée de l'aide en ligne, etc..
En général, le produit vous ’ re propose pourrait être mis en œuvre dans un certain nombre de façons différentes. Vous devez écrire un ou plusieurs spec(s) de concept pour :
• Quels sont les composants la suite documentation comprendra (aide en ligne, manuels imprimés, tutoriels, des vues d'ensemble, etc.) – « Documentation produits spécification du Concept »
• Votre documentation contient les types d'informations (par exemple, la structure de la table des matières, que vous allez pour suivre les pratiques de minimalisme?) – « Documentation contenu spécification du Concept »
• La fonctionnalité et l'interface utilisateur de votre suite de documentation (par exemple, comment cela va marcher et comment le public interagit avec elle) – « En ligne aide utilisateur Interface Concept Specification », « Imprimé Documentation utilisateur Interface Concept Specification », etc..
• La méthode de livraison (comment vous fournira de l'aide aux utilisateurs et comment vous allez mettre à jour)
• Quelles langues sont disponibles dans la documentation
Certaines implémentations possibles de conception
Maintenant que vous avez ’ ve décidé à peu près ce que vous ’ d comme pour produire, vous pouvez concevoir certaines implémentations possibles de celui-ci. Vos conceptions seront de très haut niveau et ils ne peuvent pas réellement travailler (ils peuvent être en fait juste des prototypes de papier).
Avec plus d'autres considérations déjà finalisées par le biais de votre recherche d'exigences de l'utilisateur, ces implémentations doivent ne diffèrent que par suite de :
• Les technologies derrière eux
• Les outils utilisés pour les créer
• L'apparence globale
Vous avez besoin d'apprendre autant que possible au sujet de ces choses, afin de déterminer ce qui est effectivement possible, réussie, efficace, etc.. Vous devriez être au courant des tendances actuelles, littérature, livres blancs, etc.. Ces informations peuvent être obtenues de diverses sources. Quelques bons endroits pour commencer à incluent :
• Liste des serveurs
• Conférences
• Livres
• Autres publications
• Autres écrivains
• Autres produits
Effectuer des tests sur vos prototypes d'utilisabilité
Modèle (prototype) vos conceptions pour les décideurs et les échantillons de l'auditoire. Cela vous permet de choisir les meilleurs éléments de chaque dessin ou modèle (et de déterminer des priorités pour eux). Sélectionnez un modèle (ou fusionner plusieurs dessins) que vous croyez meilleur satisfasse aux exigences de l'utilisateur. Ce processus peut être itératif. À la fin de cette étape, vous devriez savoir assez pour détailler exactement ce que vous ’ ll se produire (y compris ce qui aide la plate-forme et outil vous ’ ll utiliser).
Astuce : Pour plus d'informations sur les méthodes de recherche possible, jetez un oeil à la gestion de vos projets de Documentation par Hackos (1994) esp. pp.446-447, utilisateur et analyse des tâches de conception de l'Interface de Hackos & Redish (1998), Social Marketing : nouvel impératif pour la santé publique de Manoff (1985), conception Qualitative 2e édition par Marshall & Rossman (1995), de la recherche et “ des groupes de discussion – un Guide pour les nouveaux utilisateurs ”, en Intelligence Marketing et en planification de Tynan & Drayton (1988).
Écrivez vos exigences
Spécifications des exigences en détail exactement ce que vous devez retrouver avec. Ces spécifications doivent contenir autant de détails que possible sur les fonctionnalités de la documentation produit (pas la façon dont vous ’ ll vaquer à construire).
Spécifications des exigences sont fondamentalement une évolution des spécifications de votre concept. Une fois que vous commencerez à travailler sur les spécifications des exigences, les spécifications du concept sont gelées. Vous devez écrire un ou plusieurs spec(s) de concept pour :
• Quels sont les composants la suite documentation comprendra (aide en ligne, manuels imprimés, tutoriels, des vues d'ensemble, etc.) – « Documentation produits spécification »
• Votre documentation contient les types d'informations (par exemple, la structure de la table des matières, que vous allez pour suivre les pratiques de minimalisme?) – « Documentation contenu spécification »
• La fonctionnalité et l'interface utilisateur de votre suite de documentation (par exemple, comment cela va marcher et comment le public interagit avec elle) – « En ligne aide utilisateur Interface spécification », « Imprimé Documentation utilisateur Interface spécification », etc..
• La méthode de livraison (comment vous fournira de l'aide aux utilisateurs et comment vous allez mettre à jour)
• Quelles langues sont disponibles dans la documentation
Ressources & estimation durée du projet
Une fois que vous ’ ve issue de la phase de spécifications de besoins, vous devez en savoir assez pour estimer avec précision les exigences en matière de durée et ressources pour le reste du projet. Vous devez également mettre à jour la “ Documentation Project Plan ” document grâce à ces informations.
L'estimation est toujours un difficile processus et il n'y ’ s vraiment pas moyen sûr de faire les bons. Surtout, cela dépend de votre expérience et de l'emploi. Cependant, Voici quelques conseils qui pourraient vous aider.
Si vous avez des dossiers de projets précédents, vous pourrez simplement estimer la durée du projet en fonction de ces. Vous devriez essayer de comparer le vieux matériel de sujet et sujets avec le nouveau à veiller à ce que les vieux temps seront appliquera au nouveau projet. Sur l'autonomie de gestion de vos projets de Documentation (1994), Hackos fournit certaines lignes directrices potentiellement utiles pour la comparaison de la complexité des divers projets de documentation.
Si, en revanche, le projet est entièrement nouveau, vous n'aurez aucuns enregistrement à utiliser comme un guide (sauf si vous avez réussi un projet similaire dans le passé). Dans ce cas, les estimations de projet seront très difficiles à faire.
Une des méthodes possibles d'estimation sont :
1. Établir une liste des tâches et noter combien il se trouvent dans votre liste.
2. Dresser une liste de concepts qui doivent être documentées et noter combien il se trouvent dans votre liste.
3. À partir de votre liste de tâches, sélectionnez 10 qui sont représentatives du reste (en termes de complexité, durée prévue, le statut du développement pertinent, etc.) et de la même granularité (par exemple, vous pouvez écrire un sujet unique pour chacun).
4. À partir de votre liste de concepts, sélectionnez 3 qui sont représentatives du reste et de la même granularité (par exemple, vous pouvez écrire un sujet unique pour chacun).
5. Estimer le nombre de pages par sujet.
6. Documenter ces tâches et ces concepts comme un essai, veiller à ce que vous suivre :
• La durée totale nécessaire pour compléter chaque rubrique.
• La partie de ce temps qui est due à la modification du produit ou de l'indécision.
• Le nombre de pages par sujet.
• Le nombre de rubriques supplémentaires, inattendus, mais nécessaires, que vous a appris à la suite de la documentation. Garder un relevé du nombre de tâches et rubriques conceptuelles.
Conseil : Profitez de votre essai doco. Même si vous ’ ve choisi un design par le biais de prototypage de conception, vous pouvez utiliser votre échantillon de documentation afin de tester l'utilisabilité de votre approche de la documentation. En présentant l'exemple d'un échantillon de l'auditoire, vous pouvez déterminer si vous ’ re position dans la bonne direction avec votre doco (c'est à dire si vous avez interprété et mise en œuvre des résultats de vos recherches d'utilisateur correctement).
7. Déterminer la durée moyenne par page pour la tâche et des rubriques conceptuelles.
8. Appliquer cette moyenne sur le reste des sujets dans le projet. (Sujets écrits tôt dans le projet normalement prennent plus de temps en raison du manque d'information et un plus grand nombre de questions techniques. Cela signifie sujets écrits plus tard dans le processus seront probablement inférieur à la moyenne calculée ici. Toutefois, cela sera normalement compensée par le temps supplémentaire, changements de produit encourrez pendant le cycle de vie du projet.)
9. Estimation du temps par secteur d'activité basé sur le temps moyen par rubrique.
10. Estimer le nombre de rubriques supplémentaires et imprévues, qui deviendra probablement nécessaire au cours du reste du projet.
11. Laissez pour formation, maintien de pratiques de travail, vacances, congés, réunions, tests d'utilisabilité, production (temps de traitement environ 6 semaines pour l'impression d'un manuel de 1000 pages, y compris la vérification), évaluation et tests évaluatifs. Chacun de ces éléments peuvent varier selon la nature du projet, et ils auront tendance à prendre beaucoup moins de temps que l'écriture réelle. C'est pourquoi les lignes directrices ne sont pas fournis, car ils sont pour l'écriture.
Savoir combien de temps vous avez réellement faire cela, puis comment de nombreux auteurs vous ’ ll faut pour y arriver pendant cette période. Élaborer un planning de projet à l'aide de quelque chose comme Microsoft Project, identification des jalons utiles et des délais du projet. Certains de vos jalons peuvent inclure :
• Prototype test complet
• Travail Pracs écrit
• Conception spécifications écrites
• Première version complète
• Deuxième version complète
• Localisation de la deuxième version complète
• Projet final complet
• Localisation complète
• Le prêt de documents pour diffusion
• Production complète
• Évaluation du projet Complete
• Vérification complète de la convivialité après la libération
Il est important de noter que vous aurez les jalons avant ce point, mais parce qu'ils se produisent avant l'étape de planification formelle, ils n ’ t doivent être inclus dans la présente annexe.
Écrire travaux Pracs & spécifications de conception
Même que la recherche de l'utilisateur, travailler pracs et spécifications sont peut-être les éléments de projet plus faciles à négliger, surtout pour une petite équipe de conception. Cependant, même au sein de petites équipes, il est utile de conserver les deux.
Travail pracs sont pour des choses en cours, qui affectent l'environnement de travail quotidien de l'équipe (p. ex., l'utilisation de votre outil de documentation, comment libérer votre aide, un guide de style, etc..). Spécifications de conception sont pour documenter les choses uniques comme comment nous réellement l'intention d'aller à cette chose. Il s'agira notamment des informations telles que quels outils nous ’ ll utiliser, ce que chacun va faire, et la mécanique de la façon dont tout s'imbrique. par exemple, comment le VSS projet travaillera, comment tout devrait être questions managées, multi-utilisateurs, comment il va être localisées, etc..
Poursuite … Voir la partie 3 du présent article (http://www.divinewrite.com/docoprocess3.htm) pour plus d'informations sur l'écriture de la documentation de votre utilisateur.