• twitter image
  • facebook image
  • youtube image
  • linkedin image
Language: CMS Made Simple Czech CMS Made Simple France CMS Made Simple Hungary CMS Made Simple Russia CMS Made Simple Netherlands

All times are UTC




Forum locked This topic is locked, you cannot edit posts or make further replies.  [ 12 posts ] 
Author Message
 Post subject: End User Manual
PostPosted: Wed Aug 26, 2009 4:47 pm 
Offline
Power Poster
Power Poster
User avatar

Joined: Tue Oct 24, 2006 5:59 pm
Posts: 907
Location: Mandan, ND
Here is a link to a project in the forge where you can download "How-To" manuals for the CMSMS core and various modules. These documents are meant for the End User (ie. Secretaries, Content Editors, etc.) They are in OpenOffice ODT format so you can open them, modify them as needed and then generate PDF's for your clients.

They will be updated as often as possible. If you would like to contribute do a SVN checkout on the module and you will have access to the files/images needed, then just get me the ODT and I will release the document upon review and approval.

http://dev.cmsmadesimple.org/projects/enduserdoc

_________________
If all else fails, use a bigger hammer.

M@rtijn wrote:
This is a community. This means that we work together and have the same goal (a beautiful CMS), not that we try to put people down and make their (voluntary) job as difficult as can be.


Top
  Profile  
 
Share On:
Share on Facebook Share on Twitter Share on Google+
 Post subject: Re: End User Manual
PostPosted: Wed Aug 26, 2009 6:06 pm 
Offline
Support Guru
Support Guru

Joined: Mon Jul 24, 2006 3:27 pm
Posts: 3679
Location: Paris
I like it End Users have nice documentation targeting them. Thanks.

May I suggest to consider asciidoc http://www.methods.co.nz/asciidoc/ as the dev format of the doc ? A pony would be an asciidoc repository on github or gitorious ;-)

Pierre M.

_________________
-- Pierre, former support team member.
Please read "how to submit installation/support requests" before posting. Don't send private messages to ask for support.


Top
  Profile  
 
Share On:
Share on Facebook Share on Twitter Share on Google+
 Post subject: Re: End User Manual
PostPosted: Thu Aug 27, 2009 3:40 pm 
Offline
Power Poster
Power Poster
User avatar

Joined: Tue Oct 24, 2006 5:59 pm
Posts: 907
Location: Mandan, ND
I'll look into ASCIIDocs. The original docs that I started with were made in ODT so I kept going. My only concern is keeping it nice looking for those that will be reading it. Those reading it aren't source code geeks like we are.

_________________
If all else fails, use a bigger hammer.

M@rtijn wrote:
This is a community. This means that we work together and have the same goal (a beautiful CMS), not that we try to put people down and make their (voluntary) job as difficult as can be.


Top
  Profile  
 
Share On:
Share on Facebook Share on Twitter Share on Google+
 Post subject: Re: End User Manual
PostPosted: Fri Aug 28, 2009 2:39 pm 
Offline
Support Guru
Support Guru

Joined: Mon Jul 24, 2006 3:27 pm
Posts: 3679
Location: Paris
I agree the End User should have easy nice looking documents. Doc formatters can do this. I was only suggesting a try of asciidoc as a "dev" format (for geeks writing the doc) the End User reading it pretty from generated xHTML/CSS, PDF, RTF...

Pierre M.

_________________
-- Pierre, former support team member.
Please read "how to submit installation/support requests" before posting. Don't send private messages to ask for support.


Top
  Profile  
 
Share On:
Share on Facebook Share on Twitter Share on Google+
 Post subject: Re: End User Manual
PostPosted: Sun Sep 20, 2009 5:44 am 
Offline
Power Poster
Power Poster
User avatar

Joined: Fri Jun 08, 2007 7:29 pm
Posts: 889
Location: 's-Hertogenbosch, Netherlands
Hi,

Another media type is available via
my shop.
It is a book in pdf format that is for sale and has various chapters on maintenance of content.

[Edit]As of January 12th, 2009 a new version of the book is available. It includes more information on the admin part of the back end. Module descriptions have been updated and Guestbook has been described in detail.[/Edit]

Duketown

_________________
Want to know more about CMSMS look at my site: http://www.duketown.eu


Last edited by Duketown on Wed Jan 13, 2010 7:59 pm, edited 1 time in total.

Top
  Profile  
 
Share On:
Share on Facebook Share on Twitter Share on Google+
 Post subject: Re: End User Manual
PostPosted: Mon Jun 28, 2010 2:49 am 
Offline
Forum Members
Forum Members

Joined: Mon Jun 28, 2010 1:43 am
Posts: 41
This is excellent; thank you. 


Top
  Profile  
 
Share On:
Share on Facebook Share on Twitter Share on Google+
 Post subject: Re: End User Manual
PostPosted: Tue Nov 16, 2010 2:38 pm 
Offline
Power Poster
Power Poster
User avatar

Joined: Wed Aug 15, 2007 8:51 pm
Posts: 561
Location: Nairobi, Kenya
Brilliant!!!


Top
  Profile  
 
Share On:
Share on Facebook Share on Twitter Share on Google+
 Post subject: Re: End User Manual
PostPosted: Wed Mar 09, 2011 6:44 pm 
Offline
Forum Members
Forum Members

Joined: Sun Aug 06, 2006 2:36 pm
Posts: 85
Location: Munich, Germany
Hi,
I just ran into this documentation. The idea of writing a documentation for the end user is great – thanks for your efforts! Surely it should be expanded but I can very well feel that it‘s a long and energy-consuming effort. Thanks for having started it …
Maybe it can be expanded – it‘s also helpful for the admin as there are many modules and one cannot know every single one!

Reinhard

(I haven't checked out Duketown‘s offer, so I cannot comment on him, sorry).


Top
  Profile  
 
Share On:
Share on Facebook Share on Twitter Share on Google+
 Post subject: Re: End User Manual
PostPosted: Wed Mar 09, 2011 7:08 pm 
Offline
Power Poster
Power Poster
User avatar

Joined: Tue Dec 23, 2008 8:39 pm
Posts: 1369
I've been having an idea for a module called "Owner's Manual" (which would reside in the "CMS" menu of the control panel) where the site developer can leave instructions for the site owner. This document is editable by an admin, but read-only to others. There can be a section below, maybe, for site owner notes.

These custom instructions would be something like, "News category X controls this part of the website", "Here's how you change this, etc".

For very basic websites (4 pages and contact page), the stock end-user manual might be overkill, and custom instructions would help the average user.

For more complicated websites with news, adjustable sidebars, photo galleries, etc, the end-user manual won't be adequate, as it won't have our add-ons nor understand how we arranged it.

Of course this module would have a link to the official document as well.

Any module like this? Any modules where you can leave back-end content? How do you leave instructions for your clients?


Top
  Profile  
 
Share On:
Share on Facebook Share on Twitter Share on Google+
 Post subject: Re: End User Manual
PostPosted: Wed Mar 09, 2011 7:41 pm 
Offline
Power Poster
Power Poster
User avatar

Joined: Tue Oct 24, 2006 5:59 pm
Posts: 907
Location: Mandan, ND
As far as I know it isn't something that is available. It is a great idea though!

There are a few issues with this end-user doc.

1.) Doesn't cover many modules
2.) Could require a lot of editing to fit custom setups
3.) The document is either lost in an array of icons and folders or it is printed and stuffed in a filing cabinet never to return again.

Having something built right in that allows for Admin editing, would essentially solve all of these issues.

_________________
If all else fails, use a bigger hammer.

M@rtijn wrote:
This is a community. This means that we work together and have the same goal (a beautiful CMS), not that we try to put people down and make their (voluntary) job as difficult as can be.


Top
  Profile  
 
Share On:
Share on Facebook Share on Twitter Share on Google+
 Post subject: Re: End User Manual
PostPosted: Wed Mar 09, 2011 8:02 pm 
Offline
Power Poster
Power Poster
User avatar

Joined: Tue Dec 23, 2008 8:39 pm
Posts: 1369
Maybe I'll make a module for it then! I have so many ideas and no time to do them all.. I think I have three in-flight right now. I'm still un-published. :)


Top
  Profile  
 
Share On:
Share on Facebook Share on Twitter Share on Google+
 Post subject: Re: End User Manual
PostPosted: Fri Apr 01, 2011 5:00 pm 
Offline
Power Poster
Power Poster
User avatar

Joined: Tue Dec 23, 2008 8:39 pm
Posts: 1369
Almost... there... Hopefully I'll be done today or tomorrow with the OwnersManual module.


Top
  Profile  
 
Share On:
Share on Facebook Share on Twitter Share on Google+
Display posts from previous:  Sort by  
Forum locked This topic is locked, you cannot edit posts or make further replies.  [ 12 posts ] 

All times are UTC


Who is online

Users browsing this forum: No registered users


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 post attachments in this forum

Search for:
Jump to:  
A2 Hosting