Some comments about documentation tasks

Google's Highly Open Participation Program tries to get young students into Open Source and Joomla! specifically. Everyone is welcome, there are not limits. You can be a coder, documenter, tester, translator to help out. Jump in and start helping!
Post Reply
User avatar
mcsmom
Joomla! Exemplar
Joomla! Exemplar
Posts: 7985
Joined: Thu Aug 18, 2005 8:43 pm
Location: New York
Contact:

Some comments about documentation tasks

Post by mcsmom » Sat Dec 01, 2007 3:22 pm

I'm so impressed with what everyone has been doing.


If you are writing documentation tasks, some good things to do are:

1. Have someone help you with proof reading. I love the way people here on this forum are helping each other with this.

2. Test your documentation on someone. Ask the person to try to follow the  instructions and tell you where they are unclear.

3. By all means share your work here and elsewhere in the forums and get feedback.

4. The page lengths in the tasks are approximate except for the tri-folds. If you need more pages that is fine.

It's hard, but it is part of the process of writing good documentation to incorporate or at least cosider comments you are given.
Last edited by mcsmom on Sat Dec 01, 2007 3:27 pm, edited 1 time in total.
So we must fix our vision not merely on the negative expulsion of war, but upon the positive affirmation of peace. MLK 1964.
http://officialjoomlabook.com Get it at http://www.joomla.org/joomla-press-official-books.html Buy a book, support Joomla!.

User avatar
balvanboy
Joomla! Explorer
Joomla! Explorer
Posts: 428
Joined: Sat Sep 09, 2006 6:48 pm
Location: Novi Sad, Serbia
Contact:

Re: Some comments about documentation tasks

Post by balvanboy » Sun Dec 09, 2007 2:29 am

I finished my task before two day's but i don't have any feedback from members of community. I don't know how is my work? And i will jump on other task if this is ok.

Task # 109

Tnx anyway :)
http://www.webagencija.com | Usluge u oblasti weba!
http://www.brankopajic.com/blog | Blog o web trendovima!
Twitter @baneweb

User avatar
trombonechamp
Joomla! Explorer
Joomla! Explorer
Posts: 403
Joined: Thu Nov 29, 2007 9:37 pm
Location: Minnesota, USA
Contact:

Re: Some comments about documentation tasks

Post by trombonechamp » Sun Dec 09, 2007 12:42 pm

I have a quick question about punctuation.
If Joomla! is at the end of a sentence, should there be a period after Joomla! or not?  Seeing "Joomla!." just seems strange to me.

Thanks!
Leonard Bernstein for President -
Web Development Services: www.BernsteinForPresident.com
My Software Freedom Blog: Trombonechamp.Wordpress.com

AmyStephen
Joomla! Champion
Joomla! Champion
Posts: 7056
Joined: Wed Nov 22, 2006 3:35 pm
Location: Nebraska
Contact:

Re: Some comments about documentation tasks

Post by AmyStephen » Sun Dec 09, 2007 2:58 pm

Balvanboy - I am walking through each of the tasks this weekend and am up to 58. So, it will be a little bit, but I will review your work. Thanks for your patience.

TromboneChamp -

That is an excellent question. It was discussed a year ago, or so, by the documentation team and determined that, yes, we should include all forms of punctuation following the word Joomla!, with the *exception* of the exclamation point.

Of course, the exception to the exception is that additional exclamation points are required when stating ones love of Joomla!. So, it is not permitted to state "I want to build hundreds of sites using Joomla!!" but it is permitted to state "I love Joomla!!!!!"

Make sense?

Truthfully, you get used to it. Sadly, your writing becomes infected with an abundance of exclamation points and people accuse you of being a cheerleader. When you recognize that means they perceive you as positive, it's easy to see that the Joomla! project is responsible for spreading good vibes all over the planet! <-- see what I mean?

Have fun,
Amy :)


Post Reply

Return to “Google's Highly Open Participation Contest”