ZGameEditor forum Forum Index ZGameEditor forum
The rapid development solution with a tiny footprint. ZGE Wiki homepage.
 
 FAQFAQ   SearchSearch   MemberlistMemberlist   UsergroupsUsergroups   RegisterRegister 
 ProfileProfile   Log in to check your private messagesLog in to check your private messages   Log inLog in 

New documentation?

 
Post new topic   Reply to topic    ZGameEditor forum Forum Index -> General discussion
View previous topic :: View next topic  
Author Message
VilleK
Site Admin


Joined: 15 Jan 2007
Posts: 1569
Location: Stockholm, Sweden

PostPosted: Tue Feb 26, 2013 10:13 am    Post subject: New documentation? Reply with quote

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 Smile. 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?
Back to top
View user's profile Send private message Visit poster's website
y offs et



Joined: 22 Apr 2009
Posts: 418
Location: BC, Canada

PostPosted: Tue Feb 26, 2013 5:03 pm    Post subject: Reply with quote

.
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.



HnD.jpg
 Description:
 Filesize:  29.54 KB
 Viewed:  934 Time(s)

HnD.jpg



_________________
"great expectations"
Back to top
View user's profile Send private message
Display posts from previous:   
Post new topic   Reply to topic    ZGameEditor forum Forum Index -> General discussion All times are GMT
Page 1 of 1

 
Jump to:  
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum
You cannot attach files in this forum
You can download files in this forum


Powered by phpBB © 2001, 2005 phpBB Group