Home Blogs Carolien's blog
Carolien's blog
About 100 websites in the JoomFish contest PDF Print E-mail
Carolien's blog
Written by Alex Kempkens   
Monday, 22 March 2010 15:35

About 100 websites from all over the world have been submitted by the Joomfish community for the March 2010 celebration contest. We are very excited about it as most of these sites have been submitted within 4 days before the closing at March 16th 2010. Now is it on the Community to choose among the best multilingual websites in our showcase. Check out the Joomfish Forum to review the websites and afterwards vote for your favorite multilingual website.

The poll is closing 30th of March 2010 and after that we will announce the winning sites. The top 5 sites will be presented in blogs from our site including additional information. So let's see what the community opinion is.

 

0 Comments

JoomFish Documentation - next steps PDF Print E-mail
Carolien's blog
Written by Carolien de Groot   
Friday, 27 November 2009 20:21

Joom!Fish Help centerHello my name is Carolien and as you might know I am new to the JoomFish core team for a month now. In the article I wrote about myself I said that I'd be improving documentation. I already started a bit, and for the public most notably, I created a JoomFish FAQ (which I actually wrote because I got annoyed answering the same questions over and over again...) and I already created some articles for club members only.

So let's write down some of my plans first. I'm planning on creating the following documentation:

  • A user manual which are guides on how to install, configure, use, upgrade Joom!Fish and some troubleshooting. Maybe it also contains some other articles, but I'm not sure yet. This user manual is going to be available online and in PDF. This PDF is meant to be ready for printing, so the paper size will probably fit on US Lettersize as well as A4, the size I'm using in Holland. I'd like to be able to print my own user manual :)
  • Reference documentation. In this part all options of each screen will be explained. Partly it's going to be the documentation which is already in the PDF available for club members and partly it's going to look like the Joomla! help screens.
  • User manuals for club addons. I think all software should come with a user manual, so that is also for our club addons. The user manual will explain how to install, configure, use and upgrade the extension as well as some troubleshooting. (Yup it's the same setup as for the Joom!Fish component user manual)
  • Tips and tricks. A lot of them are online already, like the performance tips or the css tips
  • Developer documentation. I don't think I'm going to write it, I'm not a developer after all, but I'll ask Alex or Geraint to review the current documentation and update them.

Looks good eh?

And now you're thinking: when am I going to see this documentation?

I'm going to try to answer this question: First of all, some of this documentation is going to be available to club members only. This is for sure for the club addons documentation, because if you don't have access to the addons, you don't need the documentation either. If you disagree, please comment on this article :) The PDF is going to be club members only too. About the user manual: this is kinda tricky. At the moment I'm playing with the idea to create a short user manual for the public and to release an extensive one for the club members. This is still an idea and of course you could influence me by writing comments with good reasons to do otherwise. The reference documentation is also planned to be available for club members only. So what does the public get: tips & tricks, a certain type of user manual, developer documentation, troubleshooting documentation and everything else we think that should be released for the public.

Timeline: I'm aiming to get the user manual complete (and into PDF) before 2010 CET. I'm writing this gradually and every article I finished is available to club members already. For Club members, please make sure you're logged into to the frontend of this website and under Documentation, you'll find a menu called 'Club Documentation'. In there all the newly written articles and video's are available. As a club member I invite you to read the already available documentation. You have the possibility to rate it and if you have comments on it or you know some improvements or you noticed spelling errors, please use the comments of that specific article, e-mail me, or contact me any other way. All your comments are welcome, especially the ones about writing mistakes. I'm no native English speaker, so the articles definately are not flawless.

To sum up: we plan on lots of new documentation, but we can't do without you. I started writing, please give your input and comment on those writings constructively. This means: tell me what you read, how you understood this, what you expected to read and how you would improve it.

 

 

1 Comment