Welcome, Guest
Username Password: Remember me

Announcement: Documentation Plan for jSeblod CCK
(1 viewing) (1) Guest
  • Page:
  • 1

TOPIC: Announcement: Documentation Plan for jSeblod CCK

Announcement: Documentation Plan for jSeblod CCK 2 years, 3 months ago #1

  • fatbear
  • ( User )
  • OFFLINE
  • Junior Boarder
  • Posts: 24
  • Karma: 1
There have been comments in the forum that the documentation could be improved. Recognizing this, jSeblod CCK has brought me on to be the Documentation Manager and I am very eager to make the documentation absolutely superb!

We thought of just how to do the documentation, and it should be no surprise that in the end we've decided to leverage jSeblod CCK + Joomla! We had considered a wiki approach, but we recognize (1) that our audience includes Joomla-savvy users and (2) that jSeblod CCK is well-suited for constructing a very powerful documentation website with features such as advanced searching, report generation, and much more.

The documentation is designed to provide you with practical help and the plan includes the following:
  • Quick Start Guide - to get you going, well, quickly!
  • Tutorials - that focus on specific learning and micro-projects to help you do common tasks
  • Video Guides - so that you can see exactly how certain tasks are performed
  • Administrator Guide - a comprehensive guide to setting up and maintaining the jSeblod CCK
  • Design Guide - to help you through the design process with those techniques that will make your designs technically sound and visually appealing
  • User Guide - instructions for the end-user to help them realize the power of a data-oriented website and to guide them in content submission and other tasks they are likely to perform
  • Developer Guide - to learn how jSeblod CCK can be extended through APIs to work with your favorite Joomla extensions or your own organization's needs
  • FAQs - the section of the documentation that is created from questions and comments that are brought into the forums
  • Resources - a collection of code samples and other material that will help you learn better and faster

We're planning on getting the documentation website up and going with as much initial content as possible. The initial release of the documentation website will coincide with the jSeblod CCK 1.5 release. Once the documentation website has reached critical mass (sufficient initial content), the documentation website will be opened for public contributions.

And for those of you who are interested in contributing to the documentation effort, please feel free to contact us! While the documentation will provide automated language translation, we do seek native writers who wish to volunteer to translate and/or maintain certain sections of the website. For each of the sections above, we openly solicit your contributions.

If you have other documentation ideas or suggestions, please share them with us.

Enjoy!
Steve Amerige, Fat Bear Incorporated
Web Engineering | Graphic Design | Creative Marketing
Website, Java, and Source-Code Hosting

Re:Announcement: Documentation Plan for jSeblod CCK 2 years, 3 months ago #2

  • bubs
  • ( User )
  • OFFLINE
  • Junior Boarder
  • Posts: 35
  • Karma: 0
great idea! looking forward to the developer Guide
keep up the good work fellas!
best regards
/bubs

Re:Announcement: Documentation Plan for jSeblod CCK 2 years, 2 months ago #3

  • cols2910
  • ( User )
  • OFFLINE
  • Expert Boarder
  • Posts: 96
  • Karma: 0
Excellent news Steve. Can't wait to get started with CCK 1.5

Cheers,
Col

Re:Announcement: Documentation Plan for jSeblod CCK 2 years, 2 months ago #4

  • jwheeler
  • ( User )
  • OFFLINE
  • Fresh Boarder
  • Posts: 19
  • Karma: 0
first thing first, the current website's literature needs rewriting in plain English.

Doesn't really let people know what this mod does. I only tried it cause i was curious. Turns out its brilliant. But you can't tell that by reading the home page!

Re:Announcement: Documentation Plan for jSeblod CCK 2 years, 2 months ago #5

  • fatbear
  • ( User )
  • OFFLINE
  • Junior Boarder
  • Posts: 24
  • Karma: 1
Thanks, jwheeler, for the feedback. As a native English speaker, I can assure you that your wish will be granted! The style that we'll be using for documentation will focus on practical help at all levels. Of course, we'll prioritize so that the things you need to know right away are our first tasks.

So, what can you do to help? Actually, your best help for us will be to post your questions to the forum. From these, we can gauge where understanding is weak, leading to better documentation and even code improvements.

Many thanks, again, for your feedback!
Steve Amerige, Fat Bear Incorporated
Web Engineering | Graphic Design | Creative Marketing
Website, Java, and Source-Code Hosting

Re:Announcement: Documentation Plan for jSeblod CCK 2 years, 2 months ago #6

  • jwheeler
  • ( User )
  • OFFLINE
  • Fresh Boarder
  • Posts: 19
  • Karma: 0
Hi

I know your writing the documentation, so maybe you could put a page explaining the differences between the CCK and Little CCK (comparison table with features.) so people know which one right for them.

cheers.
  • Page:
  • 1
Moderators: dan1dyoung, webfacsimon
Time to create page: 0.18 seconds