Contents Sommaire

  1. Role of Manuals in Software development Manuels de rôle dans le développement de logiciels
  2. Debunking the XP Myth of Code is Documentation Démystifier les XP Mythe du code est la documentation
  3. Additional value of Good Documentation Valeur additionnelle de bonne documentation
  4. Role of Technical Writers in XP project Rôle de rédacteurs techniques dans XP projet
  5. Summary Sommaire


Role of Manuals in Software development Manuels de rôle dans le développement de logiciels
I was reading an Je lisais un interesting article article intéressant from Ron Jeffries on issue of manuals. de Ron Jeffries sur la question des manuels. I disagree with his assumptions on several aspects. Je suis en désaccord avec ses hypothèses sur plusieurs aspects. In this article we will take a look at the role of manuals in software development. Dans cet article, nous allons jeter un coup d'oeil au rôle des manuels dans le développement de logiciels. But first lets see what he has to say on this topic: Mais d'abord, permet de voir ce qu'il a à dire sur ce sujet:

  • Everyone who has done software products knows that almost no one reads the manual. Toute personne qui a fait des logiciels sait que presque personne ne lit le manuel. We know this from the technical support queries we get. Nous le savons de l'appui technique, nous obtenons des requêtes. We know it because most of us don’t read the manuals either. Nous le savons parce que la plupart d'entre nous ne lisent pas les manuels.
  • Web apps don’t come with manuals, and they’re kicking butt. Applications Web ne sont pas des manuels, et ils donner des coups de pied en bout. Some of them have a couple of help pages. Certains d'entre eux ont un couple des pages d'aide. Many have nothing but the instructions on the page and the flow of the buttons. Beaucoup d'entre eux ont rien d'autre que les instructions sur la page et le flux des boutons.
  • More and more software today is delivered on a CD, and the only manual you get is the size of the CD box. De plus en plus de logiciels aujourd'hui est livré sur un CD et le manuel que vous obtenez est la taille de la boîte de CD. Seems to work fine - science has found that more people read those little books - it’s thought that they’re looking for the lyrics. Semble fonctionner correctement - la science a constaté que plus les gens lisent peu de livres - il que la pensée qu'ils recherchent pour les paroles.
  • And hey: XP projects build the software with the highest business value first. Et hey: XP projets de construire le logiciel avec la plus grande valeur en premier. The stuff at the end doesn’t matter as much as the stuff at the beginning! Les choses à la fin n'a pas d'importance autant que les choses au début!

Manuals are definitely not needed for a simplistic shopping cart type web application, nor are they needed for many other such simplistic applications. Les manuels sont absolument pas nécessaire pour un panier simpliste de type application Web, et ils ne sont pas nécessaires pour de nombreuses autres applications telles simpliste. However to say that “almost no one reads the manual” is farthest from truth as it can be. Toutefois, pour dire que «presque personne ne lit le manuel" le plus éloigné de la vérité comme il peut l'être. For any moderately complex enterprise class applications (Siebel, Oracle, SalesForce, Extensity Expense Report and gazillion others) which require significant user interaction and expresses complex business logic, reading the manual is obligatory if you do not want to mess up in major way. Pour toute entreprise modérément complexe des applications (Siebel, Oracle, Salesforce, Extensity frais gazillion et autres) qui exigent d'importantes interaction de l'utilisateur et exprime logique métier complexe, la lecture du manuel est obligatoire si vous ne voulez pas gâcher dans les grandes.

Not all applications can be made so simple as to not require a manual. Toutes les demandes peuvent être faites de façon simple que de ne pas exiger un manuel. The underlying business logic determines the degree of complexity of the application. La logique sous-jacente détermine le degré de complexité de la demande. His article seems focussed on small simplistic applications only. Son article semble axé sur les petites applications simpliste.

Several web applications I have worked with and developed does come with full set of manuals. Plusieurs applications Web, j'ai travaillé avec développés et ne sont fournis avec un ensemble complet de manuels. Try creating a complex bioinformatics applications (not just a simple search like NCBI) without a manual. Essayez de créer un complexe bio-informatique (et pas seulement une recherche simple comme NCBI) sans un manuel.

The rest of the arguments against a decent manual is political-speech-type without much logic. Le reste des arguments contre un manuel décent est-discours politique de type sans grande logique. So I wouldn’t spend time to refute them point by point except the final one. Donc, je ne voudrais pas passer du temps à les réfuter point par point, sauf le dernier.

> And hey: XP projects build the software with the highest business value first. > Et hey: XP projets de construire le logiciel avec la plus grande valeur en premier. The stuff at the end doesn’t matter as much as the stuff at the beginning! Les choses à la fin n'a pas d'importance autant que les choses au début!

Well highest business value for most enterprise applications does include making the software understandable to all in clear simple terms and that requires a good clear documentation. Bien plus haute valeur commerciale pour la plupart des applications d'entreprise inclut le logiciel faire comprendre à tous ceux qui en termes clairs et simples qui exige une bonne documentation claire.

The ground reality is that good manuals are a strong requirement for most enterprise applications. Le terrain la réalité est que la bonne manuels sont une exigence forte pour la plupart des applications d'entreprise.

Debunking the XP Myth of Code is Documentation Démystifier les XP Mythe du code est la documentation
“Code is the documentation” (XP mantra) doesn’t cut it in the real world. "Code est la documentation" (mantra XP) ne pas couper dans le monde réel. Customers unfortunately cannot read this fine piece of documentation called code. Les clients peuvent malheureusement pas lire cette belle pièce de la documentation de code. Heck even developers cannot read some Heck, même les développeurs peuvent pas lire certains such documentation cette documentation easily. facilement.

Let’s look at this problem from a different angle. Jetons un coup d'œil à ce problème sous un angle différent. Can we make “code is documentation” a reality just for the developers themselves? Pouvons-nous faire "code est la documentation" une réalité seulement pour les développeurs eux-mêmes?

Pages: 1 Pages: 1 2