|
I almost suggested HTML. But I am so ignorant of available
tools, etc. that I thought it best to keep my mouth shut (so
to speak). Here are some very uninformed questions:
DC documentation is going to be a LARGE project. It will
consist, I am sure, of several THOUSAND files. And, to be
useful, those files will reference one another. And
several thousand files referencing one another will be
very much like the worst 'spaghetti-code' that has been
created by assembly-language programmers. I spent many
years struggling with such code.
1)So how can it be organized? Have you thought about it?
2)Are there tools to help organize HTML as a Help Document?
For example, you would have to have a 'cross-reference' tool.
3)Are you prepared to spend a couple of months outining the
shape of the documentation? This involves DOCUMENTING the
documentation project, sharing that with peers, and accepting
feedback. Without such preparation you are surely doomed.
4)Are you prepared not just to spend time doing this but
WORKING at it? Ask CocoaSpud. He is doing his part
out of love for the project but it is often hard work and
really no fun at all.
5)Can you accept help from others without second-guessing
everything they might do? This is going to be more than
one person can reasonably do. (another reason for a good
plan or outline so that parts can be delegated)
I am certainly not suggesting that you are going to come up
short on any of these issues. I just want you to think
twice before committing yourself to something you think will
be easy and then feeling the pain of failure.
|