db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Laura Stewart" <scotsmat...@gmail.com>
Subject Re: Discussion: What prevents you from updating derby documentation?
Date Wed, 25 Oct 2006 15:48:20 GMT
I'd appreciate comments from any one else about updating docs...

On 10/10/06, Laura Stewart <scotsmatrix@gmail.com> wrote:
> The Derby Documentation page that describes how to setup your
> environment, update the files, and submit patches.
> http://db.apache.org/derby/manuals/dita.html
> Yet there are very few contributors who actually update the documentation.  WHY?
> What prevents you from updating the documentation when you update the code?
> Please add your suggestions for the things that you would like to see
> updated/added to make it easier to for people to update the Derby
> documentation.
> Here are a few of my recommendations:
> 1) The instructions on the Derby Documentation page need to be more
> comprehensive... there are missing steps or assumptions made about a
> contributors knowledge.
> 1.a. The instructions for downloading and unzipping the DITA toolkit
> are for the first time that you do it.  If you already have it
> downloaded and unzipped, the steps are missing for what you should do.
> 2) For new information, there aren't any "templates" for the topic
> types: concepts, reference, task.  There also isn't a good description
> of how to decide which type to use.
> 3) There are no guidelines for how to tag the text.
> --
> Laura Stewart

Laura Stewart

View raw message