Help screens

Joomla! Documentation Workgroup

Moderator: Documentation

Locked
User avatar
Webdongle
Joomla! Master
Joomla! Master
Posts: 44093
Joined: Sat Apr 05, 2008 9:58 pm

Help screens

Post by Webdongle » Thu Mar 10, 2022 4:14 pm

Most of the Help screens in Joomla Docs just explain how to navigate to the screen and repeat the contextual help. There is rarely any full explanation of of the fields.
http://www.weblinksonline.co.uk/
https://www.weblinksonline.co.uk/updating-joomla.html
"When I'm right no one remembers but when I'm wrong no one forgets".

User avatar
brian
Joomla! Master
Joomla! Master
Posts: 12787
Joined: Fri Aug 12, 2005 7:19 am
Location: Leeds, UK
Contact:

Re: Help screens

Post by brian » Thu Mar 10, 2022 4:38 pm

Well you know how to fix that
"Exploited yesterday... Hacked tomorrow"
Blog http://brian.teeman.net/
Joomla Hidden Secrets http://hiddenjoomlasecrets.com/

User avatar
Webdongle
Joomla! Master
Joomla! Master
Posts: 44093
Joined: Sat Apr 05, 2008 9:58 pm

Re: Help screens

Post by Webdongle » Thu Mar 10, 2022 5:36 pm

No I don't because I don't know how to word a definition. You can see by my posts that, although I help find problems, I learn as much as I help. The wiki needs someone of your calibre to explain something clearly.
http://www.weblinksonline.co.uk/
https://www.weblinksonline.co.uk/updating-joomla.html
"When I'm right no one remembers but when I'm wrong no one forgets".

User avatar
brian
Joomla! Master
Joomla! Master
Posts: 12787
Joined: Fri Aug 12, 2005 7:19 am
Location: Leeds, UK
Contact:

Re: Help screens

Post by brian » Thu Mar 10, 2022 5:53 pm

Thank you for volunteering me
"Exploited yesterday... Hacked tomorrow"
Blog http://brian.teeman.net/
Joomla Hidden Secrets http://hiddenjoomlasecrets.com/

sozzled
I've been banned!
Posts: 13639
Joined: Sun Jul 05, 2009 3:30 am
Location: Canberra, Australia

Re: Help screens

Post by sozzled » Thu Mar 10, 2022 7:15 pm

There are some incredibly long discussions at GitHub about contextual help. One example is at https://github.com/joomla/joomla-cms/discussions/35594

JDOCS complements the source code but it's not necessarily any better at explaining how J! is supposed to work than what we're able to understand from reading the detailed technical discussions at GitHub. I don't know what else I can add to this discussion except to say that it's unhelpful to dismiss questions with supercilious put-downs such as "if you don't like it, change it."

I've contributed a few changes to JDOCS over the years; sometimes I've improved things and sometimes I haven't been quite as successful. I don't have enough hours in my day to rewrite everything I don't like at JDOCS. I use JDOCS as a reference tool; it's as good as any other reference tool that people could use but I know it's not 100% reliable. For those times when JDOCS lets me down, there are discussion forums (like this one, GitHub and StackIdeas and others) that fill in the gaps. 8)

User avatar
ceford
Joomla! Hero
Joomla! Hero
Posts: 2677
Joined: Mon Feb 24, 2014 10:38 pm
Location: Edinburgh, Scotland
Contact:

Re: Help screens

Post by ceford » Wed Apr 27, 2022 7:15 am

Having worked on both Help screens and Tutorials (and jdocs.joomla.org) I feel overwhelmed by the weight of accumulated documents going back to 1.5. I think the Toggle Inline Help feature in the Global Configuration screen is a great step forward. With that in place everywhere the Help screens could become more like tutorials than references. I have been working through a list of J4 tutorials recently: https://docs.joomla.org/J4.x:Doc_Pages but there is still a long way to go. Maybe one day some will replace Help screens or link from them.

User avatar
Webdongle
Joomla! Master
Joomla! Master
Posts: 44093
Joined: Sat Apr 05, 2008 9:58 pm

Re: Help screens

Post by Webdongle » Wed Apr 27, 2022 9:25 am

The fact that some tool tips are little help is not the problem they can always be improved. The problem is they are removed that is a backward step.
http://www.weblinksonline.co.uk/
https://www.weblinksonline.co.uk/updating-joomla.html
"When I'm right no one remembers but when I'm wrong no one forgets".


Locked

Return to “docs.joomla.org - Feedback/Information”