Make documenation editable by users if Ansca won't make it up to date or complete!!!

I have a suggestion for Ansca.

If you aren’t willing to provide users with a COMPLETE, UP TO DATE documentation , make your documentation editable by users

Users can then maintain the docs .
It seems that most of the questions in the forums wouldn’t be asked if there was good documentation.

[import]uid: 56054 topic_id: 10133 reply_id: 310133[/import]

I have just set up a Wiki site that everyone can use to update the Corona documentation, currently there is absolutely nothing there. It really was just installed after seeing this thread.

You can see it here - http://monkeydead.com/domains/coronawiki/doku.php - and you will need to register here - http://monkeydead.com/domains/coronawiki/doku.php?id=start&do=register - to edit/post.

I will start trying to set things up on it like sections etc but anyone is welcome to do whatever they want with it.

I have no idea if this will be popular or not but just figured it might be worth a try. [import]uid: 5833 topic_id: 10133 reply_id: 36979[/import]

Ideally we need to populate that wiki with the currect documentation or a skeleton of the headings, then we can all work on updating it… [import]uid: 33866 topic_id: 10133 reply_id: 36988[/import]

Yep, that’s the plan. Hope to be doing that tonight. [import]uid: 5833 topic_id: 10133 reply_id: 36991[/import]

hey now that’s a good idea!

It seems that most of the questions in the forums wouldn’t be asked if there was good documentation.

oh if only that’s how the world worked [import]uid: 12108 topic_id: 10133 reply_id: 37003[/import]

totally — i just fired our entire docs team -

oh wait — i just hired them back

need them to put the blame on :wink:

all kidding aside, i know our docs sux, but you can make comments on them, but still sux. we are working hard to make them better, but… …

c. [import]uid: 24 topic_id: 10133 reply_id: 37058[/import]

The comments feature on the docs is very nice – I often see someone else has asked about the very thing I wondered about and then there’s the answer.

But tying it into the forum some way might be nice – or make it easy to point to a section of the docs in a message.

For example, a unified URL for the docs would be cool:

http://docs.coronasdk.com/transitionto

http://docs.coronasdk.com/mediapausesound

http://docs.coronasdk.com/eventphase

Those would all lead to the docs for those topics – that landing page could have links to both the API and whatever other info is available for that topic.

That’s the kind of project that could return BIG dividends for users and isn’t something that would take a big hit on company time.

Jay
[import]uid: 9440 topic_id: 10133 reply_id: 37063[/import]