New documentation?

All topics about ZGameEditor goes here.

Moderator: Moderators

Post Reply
User avatar
VilleK
Site Admin
Posts: 2274
Joined: Mon Jan 15, 2007 4:50 pm
Location: Stockholm, Sweden
Contact:

New documentation?

Post by VilleK »

Hi,

Yoffset does a great job of updating the local help file but I wonder if we could do this more efficiently.

Another problems is that the online wiki is outdated because I haven't written about all the features added in the last two releases.

I'm asking for help in two areas:

- Documentation software and tools: It would be nice if we could automatically generate the local help file from the online Wiki so we don't have to update them separately. We use PMWiki now, maybe we should move to something else? Anyone have experience with this and can help?

- The documentation itself. I openly admit I find writing docs boring :). So whenever I have time for ZGE I will always prioritize coding new features over documenting older ones. We all know that the documentation could be a lot better and improving docs could lower the learning curve and attract new users. Anyone have some time for this?
User avatar
y offs et
Posts: 418
Joined: Wed Apr 22, 2009 4:26 pm
Location: BC, Canada

Post by y offs et »

.
There's all the things Help'nDoc could generate, if helpful to us.
I'm the first to admit missing a lot of the fine coding nuances you guys come up with in the posts.
Attachments
HnD.jpg
HnD.jpg (29.54 KiB) Viewed 7781 times
"great expectations"
Post Reply