[drupal-docs] [task] Tips for posting to the Drupal forums
sepeck
drupal-docs at drupal.org
Tue Oct 25 07:55:16 UTC 2005
Issue status update for
http://drupal.org/node/35025
Post a follow up:
http://drupal.org/project/comments/add/35025
Project: Documentation
Version: <none>
Component: Misc
Category: tasks
Priority: normal
Assigned to: cel4145
Reported by: cel4145
Updated by: sepeck
Status: active
Oh the heck with it, http://drupal.org/node/35172 I posted it.
Review/edit as needed. I figured we needed something sooner than later
as a start.
sepeck
Previous comments:
------------------------------------------------------------------------
Mon, 24 Oct 2005 01:37:03 +0000 : cel4145
Attachment: http://drupal.org/files/issues/drupal -forum-tips.html (2.7 KB)
Attached is a set of tips for posting to the Drupal forums,
documentation that could be included in the About Drupal handbook.
Please give your feedback on whether
* these are necessary (do we need this type of document?)
* any other items that I might include in this list
------------------------------------------------------------------------
Mon, 24 Oct 2005 01:45:08 +0000 : cel4145
Attachment: http://drupal.org/files/issues/drupal-forum-tips.html (2.71 KB)
sorry. the file name was broken on the last attachment.
------------------------------------------------------------------------
Mon, 24 Oct 2005 01:45:18 +0000 : nevets
It could be very useful, the one thing I would add is a note about
people enabling their contact tab, people often ask questions that are
better answered off line but do not have the contact enabled.
------------------------------------------------------------------------
Mon, 24 Oct 2005 01:52:53 +0000 : cel4145
Attachment: http://drupal.org/files/issues/drupal-forum-tips2.html (2.99 KB)
good advice. see if what i added does what you want.
------------------------------------------------------------------------
Mon, 24 Oct 2005 02:04:41 +0000 : webchick
Attachment: http://drupal.org/files/issues/drupal-forums-tips3.html (2.99 KB)
Looks good. I like that it stresses the point about Drupal being a
volunteer community and that people can get involved themselves, as
well as the point about Drupal being an international community and
that sometimes users can come across as abrasive or rude because of a
language barrier.
I've attached a new version that just fixes a couple minor spelling
things.
------------------------------------------------------------------------
Mon, 24 Oct 2005 04:58:22 +0000 : cel4145
Thanks!
I went ahead and posted it into the handbook: Tips for posting to the
Drupal forums [1]. Any other feedback and I can update it there.
Should I add a link in the forum posting instructions that appear on
node/add/forum?
[1] http://drupal.org/forum-posting
------------------------------------------------------------------------
Mon, 24 Oct 2005 07:50:06 +0000 : Bèr Kessels
I think you should remove the centre paragraph of the /node/add/forum
and replace it with the 6 bullets. That, and a link to the handbookis a
very good thing IMO. People hardly read a lot of text, but do read
bullets. If they are interested they will read further, i think.
Ber
------------------------------------------------------------------------
Mon, 24 Oct 2005 16:13:23 +0000 : cel4145
I understand what you mean. But I'd be hesitant to include all that text
in node/add/forum because of usability concerns. Though I wonder if it
would work to just include the following bullets with a note and link
to the full text version:
* Context-sensitive forum post titles.
* Detailed specifics.
* Ignore flames and rude tones.
* You get more bees with honey than with vinegar.
* With volunteer support, not everyone gets a response.
* Enable your contact tab.
These could also be revised so that they become clearer when separate
from the larger explanations yet still remain short. Perhaps,
* Use context-sensitive forum post titles.
* Include detailed specifics.
* Ignore flames and rude tones.
* Be polite.
* With volunteer support, not everyone gets a response.
* Enable your contact tab.
------------------------------------------------------------------------
Mon, 24 Oct 2005 17:35:27 +0000 : webchick
I would maybe do:
* Please [search] (link to search) and check the [handbook] (link to
handbook) before posting.
* Please use descriptive titles -- this allows people to better assist
you.
* Include detailed specifics -- Drupal version number, specific error
messages, steps you've tried, and so on.
* Ignore flames and rude tones -- remember that English is not
everyone's first language.
* Be polite -- you are more likely to get a helpful response.
* Remember that with volunteer support, not everyone gets a response --
please do what you can to help out!
* Enable your contact tab -- this allows people to contact you outside
of the forums if required.
This is still not *too* wordy, but expands on the points more than just
the bullets themselves. I also changed "context-sensitive" to
"descriptive" titles, because the former is a bit unclear, imo. And I
added a bullet point for the search and handbook, per Boris's comment.
------------------------------------------------------------------------
Mon, 24 Oct 2005 20:33:40 +0000 : sepeck
It needs to be top level in the handbook. (maybe use blink tags or
highlight it red or something)
Some suggestions, a new section starting.
* Drupal.org README
* New comers guide -Start here
We need an introduction to the community. I have started an attempt at
one [2], but as I got into it, I realized I was writing an introduction
to the handbook (not a bad thing, just got distracted and missed my
target).
Perhaps something along the lines of...
"
Welcome to the community. The drupal.org community is comprised of a
diverse group of people; from developers to neophytes, contributors to
non-contributers. Using Drupal as a foundation, you can build a
powerful flexible website. As with all powerful tools, what you get
out of it depends on what you put into it and your current skills.
With a base Drupal install you can build a fairly powerful site without
knowing php. If you need something beyond what is provided with the
base install and currently available contributed modules, you will need
to be familier with services [3]. If you are familier, then you will
need to be willing to spend the time learning Drupal's Developers Guide
[4]. As with all communities,
Here are some methods to use Drupal.org effectively.
[sub page] Tips to posting to the forums
[sub page] How to use the handbook
[sub page]
"
[2] http://scratch.blkmtn.org/index.php?q=Drupal.org-readme
[3] www.php.net>php and databases (primarily MySQL) , willing to learn
or pay someone for their api and
------------------------------------------------------------------------
Mon, 24 Oct 2005 21:00:33 +0000 : sepeck
Let's try it without a missing quote in a an href tag.
"
Welcome to the community. The drupal.org community is comprised of a
diverse group of people; from developers to neophytes, contributors to
non-contributers. Using Drupal as a foundation, you can build a
powerful flexible website. As with all powerful tools, what you get
out of it depends on what you put into it and your current skills.
With a base Drupal install you can build a fairly powerful site without
knowing php. If you need something beyond what is provided with the
base install and currently available contributed modules, you will need
to be familier with php [5] and databases (primarily MySQL) , willing to
learn or pay someone for their services [6]. If you are familier with
devloping, then you will need to be willing to spend the time learning
Drupal's Developers Guide [7]. As with all communities, we have our
disagreements on various approaches and viewpoints that we try and keep
civil as well as our helpful support people and occasional troll.
Here are some methods to use Drupal.org effectively.
[sub page] Tips to posting to the forums
[sub page] How to use the handbook
[sub page]
"
[5] http://drupal.org/www.php.net
[6] http://drupal.org/services
[7] drupaldocs.org>api and
------------------------------------------------------------------------
Mon, 24 Oct 2005 21:54:36 +0000 : cel4145
" I realized I was writing an introduction to the handbook (not a bad
thing, just got distracted and missed my target)."
No, I imagine you were right. IMHO, the whole About book needs to be
reorganized and revised. It just doesn't work well as a text that leads
new people through where they need to go (I have trouble finding stuff
in it), and, as I think we have seen lately with the anti-Drupal
sentiments in the forums, it needs additional information that helps
people to make better decisions about Drupal and understand what Drupal
is all about. This is something I had hoped to take on in about two or
three months.
In the meantime, I'm all in favor of you doing what you think you need
to do as long as some others agree. It may be better to start a new
issue since many may now be ignoring this one.
------------------------------------------------------------------------
Tue, 25 Oct 2005 01:32:02 +0000 : ryooki
I would change the italics to bold as the italics seem to disappear in
the text, but I guess that's just personal preference. What about
including something related to searching the issues / feature / support
requests of contributed modules, and how to do that properly? I think
also including info on how to use blockquote, code, and ?php would also
be helpful.
------------------------------------------------------------------------
Tue, 25 Oct 2005 02:05:58 +0000 : cel4145
"What about including something related to searching the issues /
feature / support requests of contributed modules, and how to do that
properly? I think also including info on how to use blockquote, code,
and ?php would also be helpful."
My original goal for this document was that is something someone would
use once they had decided to post in the forums. So it should link from
other pages where that information has already been suggested, such as
here:
http://drupal.org/support
The other information on encoding would turn this into more of an
instructional document, rather than a general guide for how to
communicate effectively. Perhaps that would work well as a sub-page?
I'd definitely say add one if you want? Perhaps another subpage that
provides detailed information on searching the forums (as well as how
to use Google to do so).
------------------------------------------------------------------------
Tue, 25 Oct 2005 02:16:36 +0000 : cel4145
Webchick-Sorry I'm just responding to your suggestion. A few thoughts:
- I don't think that "descriptive titles" works well. "Please help.
Newbie in big trouble" is very decriptive to some people (lol). Perhaps
"detailed, context-specific" titles" or "descriptive, context-specific
titles?
- as I mentioned above, I see this page as about how to communicate
well in the forums, with the assumption that this page will be linked
from other areas that say to search first.
- the problem I could see with those much longer bullets is that they
are not scannable in the full text version. so we'd have a different
set of bullets in node/add/forum, and the language would be different,
making it slightly less usable.
Then again, I could be wrong about all this :)
------------------------------------------------------------------------
Tue, 25 Oct 2005 07:33:57 +0000 : sepeck
Ok. I will review and edit my idea a bit this week and get it added at
the top of the About Drupal page.
Change the <strong> to <em> as well.
I will open another issue on it in the next day. Where the 'sub' links
are is not important. Links from this page to them would work just as
well as sub pages. I just think we need it to A. Point people to and
B. help set their expectations per your idea.
More information about the drupal-docs
mailing list