katratxo on Software Development

tail -f /var/log/brain | grep -i software

Openbravo 3 Developer’s Guide

with one comment

We have been working hard to finish the new Developer’s Guide targeting Openbravo 3. This guide contains information on how to change, extend and build further the application providing valuable information for starting developers, medium experienced and Openbravo experts.

The New Structure

Following best practices we are now using Categories as the way to structure our documentation. An overview of the categories is shown in the following diagram:

Developer's Guide Categories

  • Concepts: Contains documents that aim to explain core concepts behind Openbravo architecture.
  • HowTo: Step by step actions to achieve a goal, e.g. How to create and package a Module
  • Data_Model: Automatic generated documentation that contains the Database and Entity Model
  • Example: Documents that explain code present in the product that could be used as base for our developments
  • Reference:The hibernate mapping, REST XML Schema among other reference documents

Feedback

If you find a document that contains something wrong, outdated or not properly explained, please fix it, after all is a wiki. Note: If you want to make a large change in a document, please contact the original author explaining your proposed changes.

You could also log a defect or feature request in the issue tracker in the Documentation project. Remember to pick the right category: ERP Developers Guide.

I’ve also started a forum thread to collect your feedback and ideas on the Developers Guide.

That’s all folks!

Advertisements

Written by katratxo

July 14, 2011 at 12:41 pm

Posted in Openbravo

Tagged with ,

One Response

Subscribe to comments with RSS.

  1. Great work. The guide is a breeze to understand.

    Shankar Balachandran

    July 24, 2011 at 6:45 pm


Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: