User documentation - Done!

Permalink 7 users found helpful
Hi everybody!

Might make some people happy with this: User documentation!

I finished my version earlier than expected, how nice, and now I am offering it for download. It's about the user interface, but that's what a lot of people can use who never worked with Concrete5; the newbies.

I added the file as download. Happy reading (42 pages) :D

Some feedback, incorrect stuff, etc. would be appreciated.

(I removed some logos and names from my original document as I hate to advertise ;) )

Tom

2009-05-25: New updated version attached as download.
2009-06-23: Dutch version is added in the comments below. just ctrl+f on "Manuals dutch done"
2010-08-07: New version (with Creative Commons License) is added as download to a post in this topic, replacing the old "All rights reserved license".
Search for: "User documentation with license"

Maynar
View Replies:
bcarone replied on at Permalink Reply
bcarone
Tom that is a great paper. Clean and concise. I just read real quick but I think its great.

-Bill
katz515 replied on at Permalink Reply
katz515
Good job, man.

I'm reading it through.

Hey, just wanted to say... can you add other international groups on Page 5?

concrete5 Japanese
http://concrete5-japan.org

Remo's Switzerland site
http://concrete5.ch

Cali's France
http://concrete5.fr

Hmmm... I cannot recall anybody else.... correct me if I'm missing somebody else...

Thanks
Maynar replied on at Permalink Reply
Maynar
Yes I could add them to the list, but if that's the only thing XD

I wrote it for a dutch audience, so... Uh.. yeah only the dutch group was named, but yeah in a new version I could add them to the list. I think there is a list on the website here somewhere so I could also link to that one (which should be up-to-date more than this document)

But katz, any other thoughts? Just post them ^^
katz515 replied on at Permalink Reply
katz515
Oh ok... only for your users... I see....

To be honest, I'm also busy taking care of Japanese users... and trying to get forum set up right now...

So I only skimmed though your manual... and I like how you outlined entire operation of concrete5...

I'll take a look when I have more time....

Sorry... don't really have time much this week.
Maynar replied on at Permalink Reply
Maynar
It was the idea to write it for my own users, but I rewrote sections for a more global audience. Hopefully still goot though ;)

But as I said before, if anyone got any comments on it, please tell me so I can update my own manuals as well ;)
Remo replied on at Permalink Reply
Remo
cool stuff!
chunksmurray replied on at Permalink Reply
chunksmurray
wow thanks for the effort in writing that. you've obviously put a whole bunch of work into it!
Maynar replied on at Permalink Reply
Maynar
WEll it was required for me to finish my internship so.... I could have kept it for myself, but that would be lame against you guys. I know the manuals here are in too few numbers at the moment. Anything to contribute to the project as it is great!
Maynar replied on at Permalink Reply 1 Attachment
Maynar
I tried to add it to the main post, but that's not possible?
So.. seperate post.

No to major updates, though
shenn replied on at Permalink Reply
If you already used your document in dutch for you internship, why don't you upload that one aswell. Every effort to complete every bit of the manual is something. Because i saw this manual is only about the dashboard interface. this isn't a developers manual. Maybe we could add this on to both english as dutch manuals.
Maynar replied on at Permalink Reply
Maynar
No dutch version uploaded yet, because the community here is mainly English and I wanted to know if anything was terribly wrong before cleaning out the dutch one as well..

I can however do this now, got some time,
/me cleaning out logo's from dutch version.
shenn replied on at Permalink Reply
i'm dutch so maybe I can help you checking out the text grammar etc.

and even adding technical stuff to the documentation. So that this part is also covered up.

i'm also very active in irc channel of concrete5 (@ dutch worktimes :) )
Maynar replied on at Permalink Reply
Maynar
After lunch I will clean out the dutch version (removing company logo's etc.)

And IRC... hm... yeah.. can't go there while working.

Werk, werk, werk...
homershines replied on at Permalink Reply
homershines
I just downloaded it.
Thanks from a newbie struggling to understand the terrain. You've given me/us a road map.

Peace.

homershines
mario replied on at Permalink Reply 1 Attachment
mario
Excellent! Thanks so much!

I took the liberty of saving it to pdf format for those without Word. :) the pictures aren't quite as nice but they should work.

Here it is (791K).
Maynar replied on at Permalink Reply
Maynar
So other people can edit it as well. I am not going to keep updating that document.

But a PDF is more useful for the people who are going to read it.

Plus you can open a .doc with pretty much every rich text editor: Office Word, OpenOffice Writer, etc.
shenn replied on at Permalink Reply
Maynar is it still possible that you can share the dutch documentation to the community? Or is it because the you're not allowed to share the documentation which you wrote for your thesis.
Maynar replied on at Permalink Reply
Maynar
I got it, but didn't finish it. I can't actually upload what I have now, I have a completly translated version, but there is some stuff for custom blocks and single pages that the company I worked (yeah past tense) for I want to take out first.

I try to look again tomorrow. A quick look now makes it appear I only have to rewrite the introduction text, but I might be wrong. I also got a pm about this lately...

Just reply to this post when I am slacking again.....
DeWebmakers replied on at Permalink Reply
DeWebmakers
Hi Maynar. Thx for all the good work so far. A pity the company didn't keep you. We are waiting for the dutch translation but in the meantime the english one will do.
Maynar replied on at Permalink Reply
Maynar
Not really a pitty, it was just an internship. From the moment I walked in there I knew I had to leave in 5 to 6 months.

I will go at it again today. The dutch translation.
Maynar replied on at Permalink Reply 1 Attachment
Maynar
Added to post. Now who is happy?

- Poking me does work -_-'
DeWebmakers replied on at Permalink Reply
DeWebmakers
I'm very happy. Thx a lot Maynar.
dekelly replied on at Permalink Reply
dekelly
This is a great overview of the UI. I've found the installation process outlined by katz515 and team athttp://concrete5-japan.org/help/install/gettingready... was really well written (Japanese) and easy to understand. It answered my questions on how to display chinese characters on my English C5 install. (ie. Set collation for the database on myphpadmin to UTF8_general_ci and create a php.ini file). An English version of this installation process would be great for others who wish to make multi-lingual sites.
suzykaploozie replied on at Permalink Reply
suzykaploozie
This is excellent and exactly what my clients need to get started editing and updating their own site.

Thank you so much for taking the time and putting this together. Great work.

Suzy
myFullFlavour replied on at Permalink Reply
myFullFlavour
Anyone keen to update this for 5.4 (i.e. new features such as layouts?)
Maynar replied on at Permalink Reply
Maynar
Well don't look at me. I wrote the first thing and I think it's great so many people have had some use of it, but I've had no experience with the new versions of Concrete5 after the version I wrote the manuals for.

So, I hope some other people will pick it up ;) But then again, how much could have changed?
myFullFlavour replied on at Permalink Reply
myFullFlavour
The only major that comes to mind is layouts
melat0nin replied on at Permalink Reply
melat0nin
Have you licensed the document so others can build on it? I was just thinking it would be useful to have this as a wiki, so people can update it as new features are added to c5.

Perhaps a Creative Commons license would be a good idea?
Maynar replied on at Permalink Reply
Maynar
There is no license, no problem right?
The only thing that I asked was to leave my name in place for the school assignment it was part of, but now that that's over with it's free to use.

Either one of you people who want to continue to update this go right ahead, license it as you wish, Creative Commons sounds good.
(I propose you make it a web based version, no more .doc or .pdf)

But ehm... what's this?:http://www.concrete5.org/documentation/...

Looks like the website itself contains a pretty extensive documentation now. Isn't that more up-to-date and complete?
melat0nin replied on at Permalink Reply
melat0nin
No, without giving a license it's automatically copyrighted fully ("All Rights Reserved"). You, as creator, would have to license it as Creative Commons in order for it to work, and be specific about the particular CC license you would want applied to it.
melat0nin replied on at Permalink Reply
melat0nin
The c5 documentation is good, but it's not a 'manual' for a new editor who wants screenshots and walkthroughs on how to do simple things. I think your manual provides that, which is great :)
ThemeGuru replied on at Permalink Reply
ThemeGuru
I am starting my own C5 Doc set. This will be geared toward very basic users.

I hope to get the first edition released this week.

Cheers,

Thomas
Maynar replied on at Permalink Reply
Maynar
Is it still needed for me to release the documentation under the CC license or are you so far into your product that it is no longer needed?

Just checking because I'm now able to add the license, but I only like to do it when it is still needed.
bcarone replied on at Permalink Reply
bcarone
Mayner I think you should just add it. That way, if anyone would like to reference or add info from it, you don't have give permission all the time.

My "Beginner's Guide" is turning out nicely and will have a lot of references from what other peeps have figured out.

It is geared towards new Concrete5 users and for site owners. So far its grown to about 150 pages (with images) and is about 50% complete. I am hoping that (with the official list of acronyms and defs (used with permission from C5) some of you guys may critique it by the end of September.

ThemeGuru, the more documentation the community has, the better it will become. I am looking forward to seeing it if you release it publicly.
Maynar replied on at Permalink Reply 1 Attachment
Maynar
Having some problems with uploading the document to the main post of this topic, so I'll try and add it to this post. The document with the Creative Commons license.
ThemeGuru replied on at Permalink Reply
ThemeGuru
I am looking forward to these beginners guides.

I do hope to release it publicly but I would like to make some cash so I can purchase some text books without relying on my student loan.

I hope to get something done this week that covers everything but at the same time is a novel length.

I do plan to release different types like making themes from start to finish with the drop down menu an all.
sfia replied on at Permalink Reply
Maynar,
The Concrete5 User documentation is just what I need.
But I cannot find the download.
Where is it please?
SFIA (Ron)