On Mon, May 09, 2005 at 07:32:19PM +0200, Spiro Trikaliotis wrote: > The bad thing: I cannot even tell *what* is not so good about this > documentation. It is just: I do not find the things I am looking for, > although they are there in most cases. The problem is that I do often add things in the wrong places. The address override operators are a good example: They should have gone into the unfinished parts of chapter 7, but since they were needed to explain something else, an example using these operators was added in chapter 6.3 without formally introducing them. This leads to situations where I can point people to occurrances in the docs, but things aren't explained where they are expected, so people won't find them when searching themselves. Since most such occurrances are transient, the situation will improve for a single item, but not as a whole. For each correct addition, I will usually add one in the wrong place, so the next time one thing will be in the correct place, but another one has been added in the wrong place. I don't see a good way to improve the situation, since my time is limited. Documentation is not very sexy, so people tend to contribute code instead of doc updates. There are only a few people proofreading the docs or even contributing additions. Maybe I should add a special section "DOCUMENTATION HEROES" to the CREDITS file. Judging from the number of web page hits and search terms for the cc65 docs, the basic documentation is quite ok, but getting more detailed information is a problem. A good example are the regular questions about porting in the mailing list: The information is available, since it has been answered more than once in the list, but there is no single document that outlines the procedure. The psychologists have a saying: "describe, explain, alter". I've done the first one or two steps, maybe I'm some time able to do the third one:-) Regards Uz -- Ullrich von Bassewitz uz@musoftware.de ---------------------------------------------------------------------- To unsubscribe from the list send mail to majordomo@musoftware.de with the string "unsubscribe cc65" in the body(!) of the mail.Received on Mon May 9 21:36:10 2005
This archive was generated by hypermail 2.1.8 : 2005-05-09 21:36:13 CEST