Extreme Programming and the user's guide Ron Dzheffriz 11/21/2001

Original text at www.xprogramming.com

Let's think over methodology Extreme Programming, software products and managements to them. We shall begin with the following:

• Everyone who ever participated in creation of software products, knows, that practically nobody reads user's guides. It proves to be true those questions which act in services of technical support. It proves to be true also our personal experience because the majority of us too never looks in managements.

• To a web-appendices of managements do not write, but nobody frightens off it. Some such appendices have one-two help pages. However, the majority of them does not have anything, except for the brief instruction which the set of buttons follows.

• More and more than software products it is delivered on CD-disks, and a unique management(manual) which you thus receive, has the size about packing for a disk. Idea quite good, by the way, - scientists have found out, that more increasing(more and more) and more people are read by these(thus) tiny knizhechki (can be, they hope to find in them verses).

• And still: KHR is a methodology in which the basic attention is given value of software product from the point of view of business, and that that will be in the end, at all so it is important, as that is in the beginning.

Now we summarize all aforesaid:

• Create ON which is easy(light) for using which it is possible to understand without tolstennogo volumes of a management(manual). Well, and if it was possible to you - do not write this most tolstennyj volume! Do not listen khlyshchevatykh to comrades who on all lady will repeat: " but as so, in fact our customer wishes to receive the big thick management(manual) ". Your customer hates thick managements. At it(him) shelfs are hammered by all of them, in the same way, as at you or at me.

• Let your program will be as is simple in use, as well as a web-site. It very much will please overwhelming majority of users which all the same will not read "Management(Manual)". Besides it will essentially reduce the sizes of "Management(Manual)" that will please those, someone will read it(him) nevertheless. The quantity(amount) torn to itself a back of readers falls, the quantity(amount) of happy users increases. Actions(shares) of the company above a roof. Each developer buys "porshe".

• Create the documentation in process of work. Plan, that the documentation lagged behind development only on one iteration. If you (or your customer) want something to change in this iteration, do not forget to inform the technical writer that it(he) has made corresponding(meeting) corrections in following.

To describe any property of the program it is not more complex(difficult), than to realize. In fact if your programmers can invent and write for one iteration this chertovu a piece from zero writers should describe it(her) for same time, well as a last resort, to keep on one iteration behind. Eventually, it only drawing up of the report. If writers have not time to work in such rate - well, put their heels in a fireplace, now their time podsuetitsya. Also start up they in some years will describe the experience in the best seller " Extreme Writing - Embrace FrameMaker ".

Thus the documentation will be ready in two weeks after the termination(ending) of work above a code of the program. In two weeks you receive "managements" from a printing house. However, if to approach(suit) to business with mind(wit), these terms can be corrected a little. For example, print "Management(Manual)" even before the termination(ending) of works, and then enclose in it(him) small additional knizhitsu where will all is described that has been made for two last iterations. Or still the best variant: at all do not print documents. Translate(transfer) them in format HTML and place on the Internet or on CD with the program.

Such variant is not pleasant? Books all the same are necessary to you? Unpack(print out) them on the printer. Or poberegite a wood: give people the coupon for inquiry of the documentation. To many users even in a head will not come to order in you "Management(Manual)", and transfer of the coupon by mail will give you week-other(-another,-others) of additional time for work above reading and the publication knizhechek. It is possible to sell still "managements" at additional expense. Incomes, actions(shares), besides, all on "porshakh".

What - already agree? Wait, I yet have not finished!

òÓ-programmers work with application of Continuous Integration and do(make) frequent releases. Small releases, remember? Means, and xx should break all volume of the documentation into small portions - on every day, week, iteration and release. Believe, they with it(this) will perfectly consult, in the same way, as well as programmers.

In the field of program development Extreme Programming forces to refuse rather popular technics(technical equipment) under name Extreme Business. All well-known, that the program should be written [yesterday, the day before yesterday, one week ago - put your date] because still it is necessary kh days on preparation of the documentation, at days on packing and z - on sending.

It is interesting, what forces people to think as if to condense the schedule of work of programmers easier, than to try to persuade the writer or a department of marketing to work more quickly? Probably, because programmers are so betraid to the business that are always ready podnapryachsya, and so tugoumny that think as if them napryagi will change a situation. The department of delivery itself knows, that to it(him) to do(make), and writers (unlike programmers) always differ excellent eloquence.

Well, give, bite me. The team of xx-developers can create necessary software product, is exact keep within the schedule, moreover and keep the control that will enter into delivery and that will be postponed. The xx-command in which technical writers work, will put a product in time, and the maximum through one iteration after that will appear also all necessary documentation. It is ready to argue, that if writers will work as a part of a team from the very beginning of the project, results will be even more impressing. And then all at once it becomes clear, that at all programmers put a stick in wheels of progress.

Now start up gets to a department of delivery. And you take good writers and will invite them to work in one room with programmers. It is not necessary to specify, that they should do(make), simply start up sit and observe, how work above the program moves ahead. Perhaps, they will start to work after the first release in the end of iteration, can be it(him) will begin with the middle of iteration more conveniently. I Bet, in addition they will write the book " Extreme Writing ".

Extreme Programming. You send software product to the client precisely in time, thus prodlivaete term of a life to several programmers and trees. Really, it is the humane approach! KHR - green methodology! Only remember - to be green very much and very uneasy!