BitFormation Consulting - Rédaction d'un bon logiciel de conception de documents
Au fil des années, j'ai lu des centaines de documents de conception et, par conséquent formulé une opinion quant à ce qui fait un excellent document de conception. Cet article est une tentative de la liste des bons et des mauvais fonctionnalités que je l'ai vu dans les documents de conception et de décrire brièvement l'effet de chacune de ces fonctions.
Les fonctions d'un document de conception
Demandez à un collègue programmeur quel est le but d'écrire un document de conception est, et la réponse la plus probable que vous allez obtenir est « de laisser les programmeurs savent ce code à écrire ». Cela est vrai, mais il y a plusieurs autres raisons pour la rédaction de ce document, et ils ne sont en aucun cas moins important.
- Communiquer votre conception à d'autres:
Pour implémenteurs.
Ça coule de source. Les programmeurs ne doivent savoir ce code à écrire."Afin de les aider à écrire efficacement, la conception doit être clair, complet et bien défini.
Pour successeurs.
Il est fort probable que, à un moment donné dans le temps que vous passer à d'autres projets et laisser quelqu'un d'autre prendre en charge et être en charge de votre ancienne conception. Cette personne prolongera, ou le modifier, car les exigences changent et le système évolue. Votre document de conception originale sera alors une ressource inestimable de votre philosophie de conception, l'intention et les hypothèses. Votre successeur sera vraiment besoin de cette connaissance afin de pouvoir élargir la conception sans le casser."Bien expliquer votre philosophie de conception et intentions.
Pour les gestionnaires.
Vous avez sans doute de faire rapport à quelqu'un. Que quelqu'un a besoin de voir les résultats de votre travail, que ce soit pour évaluer vos progrès, ou d'acquérir une meilleure compréhension de la conception et les ressources dont elle aura besoin lorsque mis en œuvre, ou même pour obtenir une indication de la façon dont vous êtes bon à ce que vous faites .«Formulaire porte tout autant de poids que le contenu. Le document doit être soigneusement organisé et édité de sorte qu'il serait esthétique à regarder. De plus, le lecteur devrait pouvoir obtenir des estimations de temps du contenu.
"Le document doit être présentable. Il doit donner les différents lecteurs une vue générale des objectifs et du contexte du projet, compte tenu de la probabilité que tous les lecteurs savent pas à l'avance ce que le projet est tout au sujet.
"Le document de conception doit élaborer sur les dépendances entre les différentes phases de codage, et devrait fixer un coût concret à chacune des exigences du projet.
Ce qu'il faut inclure dans ce
A la fin de cet article, vous trouverez le modèle d'un document de conception générique ainsi que des notes expliquant ce que chaque section doit contenir. En plus d'utiliser ce modèle et le modifier en fonction de vos besoins, vous devez prêter attention aux détails suivants:
Un titre descriptif. Méduse de haut niveau Design 'est beaucoup mieux que Méduse ». Rappelez-vous que les lecteurs auront probablement plusieurs documents à lire, et ils ont besoin d'avoir une idée de ce type de document c'est.
Une page de titre séparée, formatée selon les normes de votre entreprise. Cela signifie généralement en utilisant une police très grande pour le titre.
Date de dernière modification et l'heure. Il est surprenant de voir combien d'heures sont gaspillés dans des réunions où plusieurs personnes regardent différentes versions du même document. Mettez la date sur la page de couverture, ou en bas de chaque page. Exploitez votre traitement de texte fonction automatique de mise à jour pour faire en sorte que la date est toujours correcte.
Les numéros de page. La 3ème cause de perte de temps lors des réunions est l'absence de numéros de page. La numérotation des pages aussi aider à localiser des copies défectueuses pages manquantes ou mélangées.
Une table des matières. Si vous utilisez votre traitement de texte fonction de numérotation automatique des sections, il est très probable que vous aurez pas besoin de travailler dur afin d'ajouter une table des matières ainsi. Chaque maintenant et encore il peut rendre la vie de quelqu'un plus facile.
techniques
Au fil des années, je l'ai appris et utilisé plusieurs techniques et astuces pour améliorer mes documents de conception:
Imaginez que vous écrivez la conception pour les personnes qui liront en votre absence. Essayez d'anticiper leurs questions, trivial et aussi important, et assurez-vous que vos réponses sont intégrées dans le texte.
Ce qu'il faut éviter
Un modèle de conception de document
Articles Liés