Some notes about documentation

Locked
scrut
Joomla! Enthusiast
Joomla! Enthusiast
Posts: 145
Joined: Tue Oct 11, 2005 3:47 pm

Some notes about documentation

Post by scrut » Tue Oct 11, 2005 3:56 pm

I worked through the documentation of Mambo and would like to make some comments:

1. The documentation should be enriched with screenshots. The text is nice but text w/ screenshots would be just great. Visual aid. Easier learning. And so on.

2. I think there should be one documentation that does not link to the help pages since that is confusing. I think there should be
a) An administration documentation (installation, administration, technical issues, template building...)
b) A users documentation (user stuff: add content, add pages...)
c) A tutorial for both taking a newbie by the hand and walk her/him through a set example step by step while explaining the structure of Mambo, its philosohy and its features.

3. A video where someone shows the features of Mambo
(Okay I admit it, I visited the Typo3.org homepage today and watched their videos. But they are great. Just sit back and watch and listen and learn. Videos like that would be excellent for Mambo)

Thanks

Matt


P.S. I posted this at http://forum.mamboserver.com/showthread.php?t=61600 before but I think it applies to Joomla, too.

User avatar
Giller
Joomla! Intern
Joomla! Intern
Posts: 92
Joined: Mon Aug 22, 2005 6:04 am
Location: London, UK
Contact:

Re: Some notes about documentation

Post by Giller » Tue Oct 11, 2005 11:41 pm

I agree - I know Joomla answers a lot of difficult questions for even experienced developers - however it is also very easy for COMPLETELY inexperienced users to get online - thats definitely the attraction for me.

I have installed 3 different JOomla sites and 2 of them are working and one isn't. I can't remember doing the first but the second two should be identical. I have no idea why, but one isn't working. I don't know where to look exactly apart from gambling on an hour in the forums.

It would be great to have a step by steep trouble shooting guide (possiblydrawn from the more common complaints in the forums). This would go a long way to making Jojomla more accessible.
Patience my son, patience

http://www.simplysales.co.uk UK fashion sales - simply sales

User avatar
Michelle Bisson
Joomla! Ace
Joomla! Ace
Posts: 1808
Joined: Fri Aug 12, 2005 12:47 am
Location: Quebec City, Canada
Contact:

Re: Some notes about documentation

Post by Michelle Bisson » Tue Oct 18, 2005 4:38 am

scrut and Giller,

Thanks for your feedback,  many or your suggestions like screenshots will be coming soom! We can only go as fast as we have active volunteers.

Those interested in helping should visit :
Suggestions, Modifications & Corrections forum
http://forum.joomla.org/index.php/board,59.0.html

...and this thread
Do you want to help out?
http://forum.joomla.org/index.php/topic,429.0.html

Thanks you!
Michelle Bisson, POPcliQ, http://www.popcliq.com
Joomla / OSM Trademarks Team Member

User avatar
RedEvo
Joomla! Guru
Joomla! Guru
Posts: 631
Joined: Mon Sep 05, 2005 3:45 pm
Location: Aberdeenshire, Scotland
Contact:

Re: Some notes about documentation

Post by RedEvo » Sat Nov 19, 2005 9:50 pm

Our (Scotweb.com) Joomla end user document is very near to a release. Expecting it this week work load permitting.

d
Practical Joomla! help, documentation, training, templates and support - http://www.redevolution.com

Jonas Högberg
Joomla! Apprentice
Joomla! Apprentice
Posts: 26
Joined: Tue Oct 25, 2005 8:47 pm

Re: Some notes about documentation

Post by Jonas Högberg » Fri Nov 25, 2005 2:47 pm

I would like to se one important option in the documentation. 2 lang option.

When going in the "help" there would be a scroll menu that chose second lang. It will then show a "mirror" to the right on the lang that is active.

To "see" the active relise (sv utgåva) betwen the first and second lang it must start with jusing codes maybe like this system:
X.X.X.X.X.X
1nr: Manual ex Administrator
2nr: Main chapter ex Help Screens: General 1.0x
3nr: Item title ex Global Configuration
4nr: active relise englich
5nr: active relise second lang based on
6nr: active relise second lang
Last edited by Michelle Bisson on Thu Mar 16, 2006 4:10 am, edited 1 time in total.


Locked

Return to “Archive”