Article - for a new Drupal Documentation Project

Events happening in the community are now at Drupal community events on www.drupal.org.
Wolfflow's picture

Hi All,

Just after being denied for the proposal of a new Group entry entitled "Documentation Task Force" i was referred
that here is the best place for my efforts:

For those of the Group who does not know my person and motivations, i will suggest to read some posting I already
have contributed on drupal.org to focus on the big problem to get oriented in the Drupal.org ---- DRUPAL HANDBOOKS.

  1. Is there a task force that is dedicate to correct or complete ...

This Article will take me some time to be complete. I thing it's worth writing it, even if many of you will complain and surely criticize it. Be aware that this article is wroted under the strength of a no native english and I'm going to report here as : NNE. Lets beginn:

An idiom is a phrase where the words together have a meaning that is different from the dictionary definitions of the individual words, which can make idioms hard for ESL students (Usually refers to developmental-level instruction in English language skills for non-native speakers.) and learners to understand.

Well in Italian language exist an old "saying":

  • Italian language: Analizzare con la lente d'ingrandimento"
  • German language: Etwas unter der Lupe nehmen
  • English language: "Does not exist?"
  • Wow ! "a word or phrase that particular people use in particular situations" like
    "Take something under the lens" is not in use in the English language?

    From the Google Translation tool (english --> german) I got this:

  • Take something under the lens ----> Nehmen Sie etwas UNTER DER LUPE
  • From the Google Translation tool (english --> Italian) I got this:

  • Take something under the lens ----> Prendere qualcosa sotto la lente
  •  

    That is exactly what I'm going to do with the Drupal.org first Documentation Page
     
    The Drupal.org staff, that here I just will report as "STAFF" named this page HANDBOOKS. Lets go shortly to the english definition of a "Handbook" provided by Google (the define tool):

      I chose 4 of the many definitions you get:
       
    1. A reference manual usually consulted for quick fact-finding or for a concise and authoritative survey of a topic.
    2. A collection of informational pieces on one or more subjects, arranged for the quick location of facts.
    3. A reference book that provides concise, useful data and other information on a specific subject.
    4. A handbook is a small manual, reference work, or other collection of instructions, intended to provide ready reference. A vade mecum (lat. "go with me") or pocket reference is intended to be carried at all times. ...

    So let us now resume the basically principle and definition that might be applyed for defining a
    possible new Drupal Documentation project. Despite the fact: that a small amount of knowledge can cause people to think they are more expert than they really are, i will list my short personal opinions about the DRUPAL HANDBOOKS page here.

    Preface:

    We all know if not I will go to reply and report for those who does't , internet special arguments related Communities tend to build their own slangs. I would try to theorize that the word "Slang" can be compared easily to the word "Idiom", just to simplify the range of concepts I'm trying to focus on here.

    The first misstake that the writer of this page did is viewable at the first sentence:

  • The Drupal handbooks offer a reference for those interested in Drupal whether novice or experienced, users or developers.
  • Novice ? & Experienced ? together?
    What for a gambling. That is one basically reason IMO because it comes to a such chaos of documentation on Drupal.org.
    The next sentence shows up where the invitation and suggestion to collaborate to this project
    lost control.

  • All content is supplied by volunteers, please contribute where you see a need
  • Volonteers can be any kind of visitors with different language, different level of knowledge about theirs language, different level of knowledge about Drupal and finally different level of personal pragmatism (the doctrine that truth is the practical efficacy of an idea.) applyied in writing their documentation contributions.

    .....to be continued.

    Every comment and suggestions are very much appreciate!

    Cheers

    Comments

    um,

    dman's picture

    Is the idiom you are looking for Put under the microscope?
    In English, microscope is more about looking closely in detail than 'lens' which also implies a telescope or camera which is a more limited, fixed viewpoint. "Under the lens" often means "camera" and can imply "false".
    Yeah, idiom is a funny thing.

    But for the benefit of the group here, perhaps you'd like to explain the actual proposal you are wanting to make.
    (Folk, do see the thread linked above. It's coherant and valid.)

    Is it about the Glossary improvements you want to see (Which Is Good), or about Non-Native-English support? Or are you just saying "make docs better"?

    (I can't believe that you just made up a new acronym of your own - NNE - for use in this thread!)

    Hi Dman, Of course it's not

    Wolfflow's picture

    Hi Dman,

    Of course it's not easy to define my motivations to start over a project about the Drupal.org Documentation but my intentions and motivations are due to many reasons:

    1. I started to know about Drupal almost 2 years ago.
    2. I stopped to visiti Drupal.org for a Year after my first frustrations on finding the right documentation to get somehow informed on how to use and implement the great CMS.
    3. After an year I started to visit Drupal.org again even I was aware of having a lot of troubles in implementing a Site with Drupal at the time there was only Version 4.5 - 4.7 disponible. But I was witnessing the outcome of Drupal 5.0 and could not let the finger off.
    4. My great wish was to build a Site for my Family Clan and of course it's not a simple task, considering that you also have to have some knowledge about Database Structure, but I get trying and trying and have now I little product at a very good stage.
    5. The most reason I start over discussing the Matter of the Trouble with finding the right Documentation about the many different knowledge aspects on Drupal is that I find really many posting in there the Visitors complains with right that meny sources on Drupal.org Forum and Handbooks are misleading people that are not english native and have not the time to stay 4 or 8 hours searching for the right imput.
    6. But the greatest motivation for my personal Campaign for a new Drupal.org Documentation reorganization was the Appeal of Dries that focused bery strong on the need of a new strenght towards the Drupal and consequently the Drupal.org usability.

    Cheers and thank you for your asking

    Cheers
    Wolfflow

    Some Observations on Drupal.org Handbooks

    Wolfflow's picture

    Hi, of course I know how is frustrating to reed from Users, Visitors, Newcomer and jung Drupalist that come over with the same questions hundred of times,again and again. We should not forget that especially for this phenomena we get skilled to register the needs and wishes of new user for any of our enterprises.

    I cannot say that I represent the typical Newcomer profile, but many of you that have seen some of my posting have surely thouth "Oh man this gay is really ....", I let you complete the exclamation.

    Well as one of You Guys and I mean Newcomer and as a Drupal beginner I notice that it's difficolt to orient themself on Drupal.org.

    For example:

    1. Does exist in the Handbook an conventional Index of all the content. You may say " Oh yes it's exist, you have the index of content in the Blocks on the left and right side!" , that's great, please can you tell me waht is a BLOCK?
    2. Does exist in the Handbook a conventional instaruction page that explain in simple words, what are all the items that appear in mine User Menu and what I can do with it?
    3. Does exist a page that simply describe all the possibility I , as a registered Member, have to contact Webmaster, Admins, Themes Authors & Mantainers, Module Authors & Mantainers?
    4. Does exist some Section that in simple word for Newcomer describe about all active contribution on Drupal.org types I can apply for and what and how I can deal withit and with the relative additiolnal menu I get when my Membership is approved?

    Oh yes sure all what I mentioned above exist !!!

    It's really so easy to find or have I to post an issue in one of the Forums to get an answer and description on HOWTO?

    Yes you will say :

    you may post an Issue, just find the Right Refer in the Menu Block ...bla.. bla ...bla..bla...

    That's Wonderfull.

    Why the Hell toke me 2 Years to find THAT?

    " unspoken answer: (This gay has really handicaps)"
    Logical answer: He is a Newcomer!!!

    EUREKA!! You got IT!!!

    Any comment are really appreciated
    Cheers
    Wolfflow

    a NNE(No Native English) spending some efforts in
    helping Newcomers and young Drupalist to find simple answers for Drupal.org usability.

    ...

    zirvap's picture

    1 doesn't exist. dman suggested that you create a new issue about it -- it would be useful to have, and hopefully it can be created.

    2 doesn't exist, see my reply in the issue on drupal.org

    3: I haven't seen this, and don't know if it exists. Some of it is probably covered in parts of http://drupal.org/History-mission-and-community. If you have time, you can start an issue about writing such a page.

    4 See http://drupal.org/contribute

    Oh yes sure all what I mentioned above exist !!!

    No, of course not. Noone says that the documentation is perfect. Noone says that it has all the information that it should have. Noone says that everything is wirtten in a way that is easy to understand for us who don't have English as our native language. (Myself, I'm Norwegian.) We all agree that the documentation needs more work. Lots of more work.

    A lot of us are working on improving the documentation. It takes time. There is a lot to do. Please help making it better.

    But to help, it's not enough to say "This page doesn't exist!" Or "That page is hard to understand!" Someone must take the time to write a new page, or write a better explanation. Can you help do that?

    --
    Hilde Austlid, Drupalchick

    Objective and actionable items

    Wolfflow's picture

    Thank you for your post Zirvap

    as Heine suggested in his comment on my post on Drupal.Org I tryed to build an Objective and Actionable Item list:

    First let me introduce shortly. for those that did not follow all the long postings here.

    1. I am a passionated Drupal Student, Member of Drupal.org.
    2. I have been educated mainly in the Italian language and have German speaking Parents
    3. My english knowledge come from school about 30 years ago.
    4. My goal is to learn to use Drupal to a degree that allow me to build resonable good HP
    5. I am also interested to Build my own THEME and then share it with the Community
    6. I like to be active in the Forum and also make some Contribution to the Hanbbok.

    Ok hope this was not to much. Lets go to analise what happened with my posting at Drupal.org
    Is there a task force that is dedicate to correct or complete ...

    I will make a list of objective and actionable items.

    Possible Objectives:

    1. Index page (Like a Site Map) for the Drupal.org Site

    2. Thesaurus page divided in Sections
      (a. Drupal specific Terms)
      (b.Common used Drupalist abbreviations)
      (c. Common used TECH IT terminology)

    3. Drupal.org members Features Page
      (a. logged in members Block Explanation)
      (b. logged in Documentation-Team Members Menu-Blocks description)
      (c. ogged in Webmaster-Team Menu Menu-Blocks description)

    4. Issue conventions and Listing of the most important Feedback Departments:
      Administrators Issues
      Webmaster Issues
      Moderators Issues

      It could be usefull to have a Menu that link to the main feedback Section that
      Logged in Members use Most to send feedback about posting and Issues where
      there is corrections, cutting, linking etc. jobs to do.

    Please post any suggestions and question if my english text in unclear and needs to be corrected or better expressed or/and explained.

    Thanks

    Wolfflow
    a NNE spending some efforts in
    helping Newcomers and young Drupalist to find simple aswers
    for Drupal.

    Some more Feedback

    Wolfflow's picture

    Hi, All

    Relative to a posting of mine (on Drupal.org) that I think, due to my limited knowledge of the english language and not used to write clear Reports like a: Project Plan or a Workflow Documentation for a Task and Team (I never worked for a big Company) happen that I caused a bit of missunderstanding.

    In the great respect of all the Drupal.org Volunteers that every Day and Night do a great Job(helping out with explanation and indications) in the different Sections on Drupal.org Site I will try to express and list here as shortly as possible the points where IMO Newcomer and Visitors to the Drupal.org site can getting confuse and so having it difficolt to inform themselves about Drupal and all the possibility they can get as registered Members.

    I hope this will help to motivate more CMS interested People to take a look at Drupal.org and Join this marvelous Open Source application that IMO is the best what ever was build.

    1. The first thing an User that comes to surf to Drupal.org see, is the Frontpage.

      IMO it is important to publish there the last Events and News about and around Drupal,
      but I think IMO that Visitors that comes for the first Time to Drupal.org were motivated
      about 90% because they have read or heared about a new CMS.

      Idea:
      Is not better to present a front page that give the mirror of the top
      of the functionalities and capabilities of a so great CMS. ?

    The Front Page is a place where in general speaking of Webdesign, you find
    all the Indications that will help you to find exactly and quickly what you are looking for.
    You will see a Menu bar where you will find the most important sections of the Site.

    On Drupal.org frontpage I see following Menu-Bar Objects:

    1. Documentation
    2. Download
    3. Support
    4. Forum
    5. Contribute
    6. Contact

    I am sure not a professional Webdesigner but it spring to my eyes that if I click on the item -
    Documentation I will have to focus first where I shoould go further.

    Please try not to missunderstand me, my impressions are comeing from someone that is not Native English and not confident with the overall structure of the Drupal.org Site.
    I remember very well that the first time I saw that Documentation Page I got confused from the many bolds words and from the to many infromations prsent on it.

    I can assure that it's right to divide the Visitors in 2 Class:

    1st.Class : Is a Newcomer. Not expert, not Competent
    in a simple word a Begginner!
    and that will always be the mayority of first Drupal.org Visitors.

     Do you agree with me?
    

    2nd. Class: This is the Class of : members, drupalist, experts and students
    that are strong motivated to find their Information and will sooner or later just get back
    a few times again on that Documentation page and mostly because they will show and
    indicate to other new Drupal interested people where they can go deeper in the m Drupal
    matter and find dettailed documentations.

    Idea:
    IMO this Documentation-1st-Page must have a Section for Beginners
    and another Section for Experts. This mean that all the huge Documentation volume should be undertaken a selection and reorganization work and is sure not a easy and short Term Task. But I think that should be done sooner better then later categorized in respect of this principle, bacause I'm sure Drupal will be in the next time the most used CMS in the World. I can immagine that a huge more number of Drupalist will want to register and contribute on Drupal.org.

    Notice: Why should the Support Menu-Bar Item be also there on the Front-Page ?

    IMO I think that a NEWS Menubar Item will be better. And you will find the SUPPORT Menu-Bar Item in the DOCUMENTATION-PAGE (Section). So as in the FORUM Section.

    I notice that the Drupalist in general will want to feel themselves as an omogeneus member off all others drupalist and that it is usual procedure that they respect and support and defend their great contribution as a big Family.

    I know that but everybody knows that each individual has it's own learning courve and each group of individual on the same curve point and level will get the right Lead for that level.

    I dont know if you understand all what I want to express here and I am aware of it that in myght be not in the right order and I exuse me for that.

    Ok I think I have wrote another piece of my Thoughts that have only the intention to give to the Documentation Team and Webmaster of Drupal.org a simple Feedback from a simple long time User and appasionate Drupalist.

    Cheers
    To be continued.


    P.S. Please don't ask me to Organise all of my writings an do a Organiser Job that is beyond my capability. Thanks

    Wolfflow
    a NNE spending some efforts in
    helping Newcomers and young Drupalist to find simple aswers
    for Drupal.

    ...

    zirvap's picture

    You describe a lot of changes, some big, some small. I suggest you choose one or a few small things to work on first. It's easier to get something done if you take one thing at a time.

    I remember very well that the first time I saw that Documentation Page I got confused from the many bolds words and from the to many infromations prsent on it.

    When I look at http://drupal.org/handbooks now, I think is quite good for beginners. It gives a clear link to click: Getting started (and aslo Start here, which points to the same place.)

    BUT: When a new visitor goes to http://drupal.org/getting-started, that page is much harder to understand -- there are too many choices for a starting place. There's both "Overview" and "Before you start", and there are three versions of Drupal in the menu. It would be good to make that page simpler, move some of the links to other parts of the handbook, or perhaps add some text that gives better information for new people.

    --
    Hilde Austlid, Drupalchick

    The A-Z of Drupal Jargon

    Wolfflow's picture

    The A-Z of Web 2.0 Jargon

    at this site : http://imagexmedia.com/ I have find a great example of what I tryed to suggest for Drupal.Org Handbook Section. Maybe I will try to build an example for it.

    Cheers
    Wolfflow

    My new start

    Wolfflow's picture

    It seem that I'm the only one interested in doing something for newcomer. Anyway.
    After some time I got started again with a Tutorial Site. I organise this in 4 Subdomains.

    The main site is http://www.adaccs.at

    Subdomains:

  • drupal.adaccs.at: here I'm collecting all tutorial articles that are simple to understand for every newcomer.
  • test.adaccs.at: here I will collect usability example that characterise each module. documentation will be linked to the first subdomein.
  • themes.adaccs.at: here a collection of the most used Drupal Themes and example on layouts
  • chat.adaccs.at: Here people interested in this project and in need for support can communicate online as visitors or
    as registered members.
  • I do this to make my Drupal Knowledge and support on Drupal.org stable and more competent.
    So if any reading this have suggestions, hints and ideas on how to make it better are very welcomed.

    Cheers
    Wolfflow

    Even if I feel really a

    Wolfflow's picture

    Even if I feel really a lonley person, without companions in the field I'm actively working on, I will report about my progress.

    On my Site I'm starting a Tutorial for those begginner like me that discovered Drupal and wnat to start learning it and get as much as fast experience in using Drupal and get the basics knowledges for avoiding common begginner errors.

    My first Tutorial starts from the installation of a Drupal Test environment on Windows systems (I'm going to add Linux too) you may see the article on ---> http://drupal.adaccs.at/?q=node/6

    Not all the steps are ready yet but they will be soon.
    For my contribution as to put on Focus some begginners Problem on Drupal.org here you may find another 2 Articles:

    http://drupal.org/node/289247 --> Some really confusing evidence
    http://drupal.org/node/289235 ---> Vistitors and Beginners that have an honest interest in Drupal

    feedback is very much appreciated
    Cheers

    Cheers
    Wolfflow

    Newby Beginner etc.

    Wolfflow's picture

    Hi All, I take the opportunity to present (represent! to some on Drupal.org) my self to the community. I just joined the Drupal Association as an individual members and are very proud to be part of this great community.

    As a beginner even thet I am a registered user of about more then 2 Years yet, I started a Drupal site with following
    purposes:

    ADACCS DRUPAL is a no profit project that aim to build Tutorials for Drupal Newbys. Myself dedicate (only one at the moment) some time to collect Drupal.org documentation that can be shaped and edited in a more organised way.

    The target is to collect essentially documentation that may refer as a Drupal Map of Site for granting a general and clean overview of members & Drupal Groups activity that help Newby and Beginners to orient themself on Drupal.org and relative important sub-domains and containers direct amministered my Drupal.org Members.

    If you like to join this community please use the feedback form and select the category "Collaboration". Fill the form and write what ever you want let us to know about you and your purposes, we then will contact you.

    Consider that I'm not a native english (NEN abr. for "no english native") speaker and that after a reasonable period of development all documentation provided on this Site will be transleted in Italian and German with the Help of a great software and of course of my mothers languages (Italian & German) knowleges.

    To all I send my Kind Regards with the hope you my contributing, indicating interesting Drupal.org page, node, postings, comments etc. that should be paid more attention and be essential to collect in this project.

    Thanks

    Cheers
    Wolfflow

    Terminology and Common expression & acronyms used on D.O.

    Wolfflow's picture

    Hi All,

    This is a summary about my activity on Drupal.org and what is about my engagement with the realization of a central place where Visitors and Members can easily find some definitions about the Drupal Glossary & Terminology as also about Common expression & acronyms used on D.O.

    Information pages about Documentation (Work and Support) on Drupal.org

    1. Contributing to documentation
    2. Documentation writer's guide
    3. Joining the documentation team

    First a list of Issue that may explain and give a better overview about this Project:

    1. A bit of History on Drupal.org Terminology
    2. The importance of Terminology
    3. Make the terminology page easier to find:

    A mailing list informing and discussing the work of the "Documentation Team" :
    http://lists.drupal.org/listinfo/documentation

    Some Working Groups were started to help out and discuss this:

    1. Beginner Documentation (this Group)
    2. Documentation Team

    As we can see a lot is undergoing toward the Goal to provide better documentations resources for our Visitors and
    Drupal.org Members. I my self am very proud 1. to have joined the "Documentation Team" (BTW as for a casual research on google for "Request to Join "Documentation Team" I get a result of 4000 request!!!) then after a period of intense work on the Drupal.org Handbook I was nominated for site maintainer and continue my modest support to see one Day (I guess very soon) that Drupal.org will have a really centrallised "INDEX" where you can find "Glossary" "Terminology" and links to the most important information resources of Drupal and Drupal.org.

    So you may see what you and I can do and achieve with a continuous engagement starting with simple Post: Is there a task force that is dedicate to correct or complete ... to
    be invited with a nomination for site maintainer in this fantastic OPEN SOURCE COMMUNITY: Drupal.org

    Kind Regards
    Wolfflow

    Documentation

    Group categories

    Event type

    Post type

    Group notifications

    This group offers an RSS feed. Or subscribe to these personalized, sitewide feeds: