Re: Opinion on pyblosxom
will <[email protected]>
| Newsgroups | gmane.comp.web.pyblosxom.user |
|---|---|
| Message-ID | <[email protected]> |
On Tue, 18 Mar 2003, Wari Wahab wrote: > > Yes, documentation department here is weak, and I'm to blame for it :) PyBlosxom development moves along very very fast. The differences between .6 and what's in CVS right now are huge. We tend to experiment with code and solutions to things by checking them in (something that I was originally adverse to, but it seems to work really well with this team) and discussing things. As such, it doesn't make sense to document everything when it gets added to the code-base--it's best to let things simmer a bit. That's one of the reasons there's been a lack of documentation. The other reason is that we're all busy programming and having babies and silly things like that. In this model, documentation comes in the gaps when we're not programming--or someone steps up to the plate and becomes a documentation person. > > I think that documentation allow more users to come in and more users > > mean more developers (and the other way as well ;-) > > I know this. And what's worse, documentation is the hardest part too :) It's not really hard in the sense that documentation itself isn't difficult to write. In our case, however, we have information that should make it into the documentation in a variety of places: 1) the actual code 2) the cvs checkin comments 3) the ChangeLog file 4) the pyblosxom-devel archives The latter one gets dicey since as we're doing development we toss around ideas and over half of them don't get implemented the way they're tossed around. I'm spending time now distilling all the data and working on programmer documentation. I'll keep people up to date on my progress. Right now my work is centralized at: http://www.bluesock.org/~willg/pyblosxom/ /will ------------------------------------------------------- This SF.net email is sponsored by: Does your code think in ink? You could win a Tablet PC. Get a free Tablet PC hat just for playing. What are you waiting for? http://ads.sourceforge.net/cgi-bin/redirect.pl?micr5043en