[osiris-devel] 3.0.4-current development documentation?
thomas.jones at linux-howtos.com
Sun Feb 22 05:30:26 EST 2004
-----BEGIN PGP SIGNED MESSAGE-----
On Sunday 22 February 2004 15:39, Alexei Roudnev wrote:
> Sorry, Tom. Of course, it is not a bad idea, and it is only a _disk space_
> But remember, that 99% of all users do not need your xml, dtd etc - they
> need plain text on the screen, so pdf file or html file looks quite enough
> for the _binary_ distribution. Anyway, it's not important, I have not any
> Doxigen (JavaDoc etc) is quite another issue. In real projects, it is not
> _redundant_. Reason is very simple: - documentation is edited and corrected
> by _technical editor_, _technical corrector_ etc; - you do not want them to
> edit a sources;
> - you do not want to have a include file, having 90% of the documentation
> and 10% of the source code.
I am a Technical Education Specialist for a Fortune 500 company ----- I am
pretty sure that i understand the theory behind technical documentation
procedures and/or processes.
If you had noticed, I made the comment that the core developers utilize
JavaDoc. This was not posted to the User List. Thus, it is a generally
accepted as a reasonable request for technical individuals.
I think you may be getting the standard documentation procedures confused and/
or integrated with your backward way of processing data. The whole process
you ranted about is simply useless. You again are highly confused; and
elaborate exceedingly about irrational ways to perform various procedures.
Even though they(standard procedures) are widely accepted by the developemnt
Here are a couple example highlights:
- But remember, that 99% of all users do not need your xml<snip>
This is a development reference, on a development list. Enough said.
- - .cpp and .h files, used to generate detailed references to the api
Doesn't ALL documentation "generator's"; utilize the same files as above?
- - a mess of 90% useless reference manuals
Any documentation that applies to the referenced material is not useless. It
may very well be beyond the scope of your knowledge; but to other more
advanced developers it is very efficient.
Rather than providing your unorthodox ways of performing various procedures;
it would considerably easier if you were to just make contributions to the
project in the areas that you feel you are exceedingly qualified.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.2 (GNU/Linux)
-----END PGP SIGNATURE-----
More information about the osiris-devel