Improving our public developer documentation

Posted by Sigurd on 20 October 2008

A key part of making it easy to learn how to use SilverStripe, or any other software project for that matter, is having great documentation. The PHP language, for example, now enjoys widespread adoption and is easy to learn in large part due to free and comprehensive documentation.

We're excited to say we've spent considerable time recently reviewing our existing tutorials and documentation, and discussing how to improve them. We'll let you know more as our plans develop.

4 Comments. Add Yours Tags:

Post your comment

Comments

  • Cool - keep the feedback rolling in!

    Posted by Sigurd Magnusson, 1 year ago

  • This is good to see - I'd love to see the wiki docs in particular put into a more structured hierachy.

    Documentation is a really critical part of any open-source project, and its great to see this being acknowledged!

    Posted by ajshort, 1 year ago

  • Hi, great news, I have sucessfully broken 2 trial websites now trying to setup relationships. I am quite happy to make my own mySQL db to do things, the issue is more coming to grips with the framework and how to use it.

    I find that I am having to troll the forums where I find snippets of answers. And as you are no doubt aware, I can't search for a previous answer unless I am asking the question correctly in the search. I'd suggest you include that as a source for both the types of questions and also the solutions etc.

    Posted by Lindsay, 1 year ago

  • I am "almost" in love with Silverstripe. The idea if fabulous. The only problem is that your documentation and instructions assume too much knowledge of both PHP and the software. How about developing a documentation track for novice users who are willing to learn?

    Posted by Mike, 1 year ago

RSS feed for comments on this page | RSS feed for all comments

Looking for our Open Source Software? Then head to SilverStripe.org.

Comments on this website? Please give feedback.