3 4 DB Documentation Manager

DB Documentation Manager for 3.4 Proposal

Overview

The role is coordinated with Documentation Manager. Is a role to help developers to keep dev and documentation about tables/index/relation in sync.

This role is connect with my previous work on documentation of MySQL tables, indexes and links between tables. I think we need some one that every time a new table, a new index, a new column ask to the developer to describe the new situation.

In fact I ask the moral authority to ask questions about the topic and to request an answer. We can't insert comment od description into .sql file because for 3.4 we want to use an SQL abstraction level. The SQL abstraction level is mandatory to support Koha on MySQL and Postegres.

I will document the information in a xml file, with a specific ad public available syntax. The syntax doesn't came from myself but it is the syntax of SchemaSpy.

With this xml will be possible to create in an automatic way web pages about SQL structure.