ant-user mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Daniel Barclay <dan...@fgm.com>
Subject Re: List of frequently found gotchas
Date Fri, 02 Apr 2004 16:26:12 GMT
Stefan Bodewig wrote:

...
> 
> 
> If there are any "frequent" gotchas that are not already covered by
> the FAQ, everybody is welcome to contribute to the FAQ or Ant's wiki.

Wasn't part of the OP's point to put the information near the existing
documentation of the relevant feature (e.g., missing exception trace-
back detail near the "fork" attribute documentation) so the reader will
notice it instead of having look elsewhere?

Think about how footnotes (or, better, endnotes) are done:  The
author leaves a pointer (the superscripted note number or symbol)
right in the middle of the relevant text so the reader sees it.


Also, note that a frequently asked questions list (except for
newsgroups) almost always indicates that other documentation is
deficient.  (How many FAQ lists start out with "What Is <software
package>"?  Clearly, in those cases there should have been an
introductory document.)

Daniel


---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@ant.apache.org
For additional commands, e-mail: user-help@ant.apache.org


Mime
View raw message