SIF Framework database - lack of robust, enterprise grade documentation

[kunalyadavdfe]

Environment - "Simplicity": SIF Framework database - lack of robust, enterprise grade documentation. Thus making it harder for smaller suppliers to understand how to develop and implement a SIF environment. We understand that the approach is to write code first and then develop a database automatically using NHibernate, but this needs to have excellent documentation to clearly indicate what the tables and columns are and their intended use. There is no clear enforcement of database concepts and it looks like a free for all database where anything and everything is possible. This has caused a lot of confusion and debate as things marked mandatory in the specifications are not really mandatory in the database and no uniqueness constraints are built in. There are potentially several other instances too but with no guidance on how this critical component of the framework is used it just leads to speculation and varying interpretations.

[iantasker]

@rafidzal Would you be able to contribute any additional documentation regarding the implementation of Nhibernate?

[rafidzal]

Documentation in the area of database design and usage needs to be enhanced significantly. However, enhancements to the SIF Framework to ensure compliance with the SIF Specification has previously taken precedence over documentation. Improvement to the SIF Framework documentation is ongoing.

@iantasker As NHibernate already provides a significant level of documentation for developers, it is not expected that a tutorial resource for NHIbernate usage will be included in the documentation of the SIF Framework. Instead, the existing documentation will be enhanced to better explain the current database schema design and usage. Such documentation will be independent of ORM or database used.