[kdewebdev-site] kdewebdev.org proposals
David Joham
djoham at kdewebdev.org
Mon Apr 26 23:33:29 EDT 2004
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
On Monday 26 April 2004 07:10 am, Chris Hornbaker wrote:
Hi Chris,
One more thing: If we go with your idea, we're going to have to document step
by step the tools needed to work with this proposal. I'm up for working on
the docs while you code, but you'll have to hold my hand the entire way. Are
you willing to do that?
You might be wondering why I'm so anal about documentation. Just for the
record, I consider it my job to be easily replaced. If at any time I get hit
by a bus, I need my replacement to be able to take a look at the
documentation and instantly know how the site performs (for example) its
localization. I plan on translating your proposals into a detailed design
document for archival purposes.
By detailed design, I mean *everything* that goes into the design. It's not
enough to say "go get tool X and learn it". It has to be "go get tool X and
take a look at appendix B in the design documentation for how we use it on
this site"
Writing this stuff is the dull and tedious portion of code work. That's why
I'm going to do as much of it as possible to keep it away from the folks
doing the "real" work. However, I'm going to need help from the folks doing
this stuff so that I can learn enough to write the documentation. Everyone
should keep this in mind when they do their proposals. Less complex means
less questions later from me :)
David
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.4 (GNU/Linux)
iD8DBQFAjeKadGtRHnP4AioRAhqzAJ4o1mku4rXRJxDvE4zIClTgpG9LeQCfTnIj
s0tYOIBDNpxqPr/+hVabdE8=
=RarA
-----END PGP SIGNATURE-----
More information about the kdewebdev-site
mailing list