Docs all in one place

A place for users to point out missing information, errors, typos and suggestions for the Cinemar documentation.
pgale
Intermediate
Intermediate
Posts: 256
Joined: Wed Feb 12, 2003 6:35 am
Contact:

Docs all in one place

Postby pgale » Sat Dec 23, 2006 5:58 pm

Please, please, please can we have all the docs for ALL the components, plugins etc in one place. Curently there's a mixture of PDF's, readme's, help files and text in the about boxes.

Gets frustrating sometimes trying to remember where you found a reference to something.

Can we have all of these copied to a central location on the Cinemar web site or a forum here?

Thanks,

Paul.

User avatar
DavidL
Simply Incredible
Simply Incredible
Posts: 11071
Joined: Sat Feb 08, 2003 9:39 am
Location: Metamora, Michigan
Contact:

Postby DavidL » Sun Dec 24, 2006 2:47 am

The most standard place is mlserver\documentation directory.

User avatar
gregoryx
Simply Incredible
Simply Incredible
Posts: 6599
Joined: Tue Sep 30, 2003 10:15 pm
Location: Newport Beach, CA
Contact:

Postby gregoryx » Sun Dec 24, 2006 3:18 am

smoothtlk should have wrote:The most standard place NOW is mlserver\documentation directory.


:P

pgale
Intermediate
Intermediate
Posts: 256
Joined: Wed Feb 12, 2003 6:35 am
Contact:

Postby pgale » Sun Dec 24, 2006 6:12 am

But there are lots missing from here yes?

I'm talking about having something on the web or forum - for those plugins (free and purchased), so users can view them all in one place for reference and to see if a plugin is worth buying or not. I'm sure this would also contribute in a small way to new purchases :)

I don't think it's a huge amount of work for the improvement in clarity :)

User avatar
gregoryx
Simply Incredible
Simply Incredible
Posts: 6599
Joined: Tue Sep 30, 2003 10:15 pm
Location: Newport Beach, CA
Contact:

Postby gregoryx » Sun Dec 24, 2006 3:13 pm

I think that's supposed to be the point of this forum section eventually.

:)

TheCodeMan
Senior Member
Senior Member
Posts: 204
Joined: Fri Sep 22, 2006 12:16 pm
Contact:

Postby TheCodeMan » Wed Dec 27, 2006 7:36 pm

I have a couple of suggestions. I agree that a documentation forum is long overdue. I think Cinemar should create a topic in the documentation forum for every release that has some form of documentation. The topics could be locked and modifiable only by an admin and should contain the latest release of documentation related to the topic. Leave it up to the user to copy the latest version of docs to their local documentation folder.

Alternately, the topics could be unlocked where power users can comment on the docs or add specific tutorials to the topic.

Just my 2 cents (i.e. all I have left after getting into this home automation hobby!)

:D :D :D

kirkfrey
Expert
Expert
Posts: 759
Joined: Wed Jan 12, 2005 10:55 am
Contact:

Postby kirkfrey » Sat Jan 27, 2007 10:35 am

I think that this forum would be a perfect place for sticky topics for each product containing the most current document.

Also, a single form for all documents would be great as well - some are PDF's (prefered) some are help files...
Kirk

Just trying to figure it out...

User avatar
gregoryx
Simply Incredible
Simply Incredible
Posts: 6599
Joined: Tue Sep 30, 2003 10:15 pm
Location: Newport Beach, CA
Contact:

Postby gregoryx » Sat Jan 27, 2007 3:01 pm

Not exactly taking off so far, eh?

I suspect a Wiki or FAQ or other format makes more sense for documentation. Something with some structure that makes it easier to help users and can be easily cleaned and/or restructured by admins.

blafarm
Expert
Expert
Posts: 632
Joined: Mon Sep 29, 2003 8:45 pm
Contact:

Postby blafarm » Sat Jan 27, 2007 5:01 pm

Yeah, this particular forum doesn't seem to be moving anything in a forward direction. Although they are admittedly a hardware company, I think
Infrant's Wiki is an interesting model for how Cinemar's documentation might be improved.

User avatar
DavidL
Simply Incredible
Simply Incredible
Posts: 11071
Joined: Sat Feb 08, 2003 9:39 am
Location: Metamora, Michigan
Contact:

Postby DavidL » Sat Jan 27, 2007 5:09 pm

If you noticed, there is a new Docs section in the MLServer (latest beta) Help / Additional Software Downloads. only three docs in there so far, but ultimately all will be. Several suggestions from this thread have been incorporated into a few docs already. Don't give up. Continue with the suggestions.

User avatar
gregoryx
Simply Incredible
Simply Incredible
Posts: 6599
Joined: Tue Sep 30, 2003 10:15 pm
Location: Newport Beach, CA
Contact:

Postby gregoryx » Sat Jan 27, 2007 5:16 pm

I'm not giving up. Pretty hard to get me to give up if I'm not ready. :wink:

Still... wiki that can be built by users as well as Cinemar (but policed by Cinemar) seems like the best way to build content faster than three at a time. Or not. 8)

User avatar
DavidL
Simply Incredible
Simply Incredible
Posts: 11071
Joined: Sat Feb 08, 2003 9:39 am
Location: Metamora, Michigan
Contact:

Postby DavidL » Wed May 16, 2007 1:50 pm

Cinemar now has a Documentation Wiki (as per your request :) )
www.cinemaronlineforums.com/wiki

User avatar
gregoryx
Simply Incredible
Simply Incredible
Posts: 6599
Joined: Tue Sep 30, 2003 10:15 pm
Location: Newport Beach, CA
Contact:

Postby gregoryx » Wed May 16, 2007 4:25 pm

Love it.

Should that link be on every forum page as a reminder?

dormie1360
New Member
New Member
Posts: 46
Joined: Thu Nov 25, 2004 1:37 pm
Location: Louisville, KY
Contact:

Postby dormie1360 » Wed May 16, 2007 7:46 pm

Nice addition. Especially for those of us who are mentally challenged. :)


Return to “Documentation”

Who is online

Users browsing this forum: No registered users and 1 guest