home.md

+Estructura
+----------
+
+Aquest projecte està pensat com a vertical. Tindrà una opció de menú principal des d'on s'accedirà a tots els models i assistents relacionats amb aquest vertical. Aquest menú, de moment, es diu `ISP`.
+
+El mòdul principal del vertical és `ewan_isp`. Dins d'aquest mòdul es definiran tots els models relacionats amb la gestió d'un ISP local propis d'aquest vertical, com ara Contract, Contract Type, Delivery Points, Fiber, Phone, Mobile, Rate, Bonus, Call Detail, Call Import, etc.
+
+Quan es vulgui integrar una altra funcionalitat de l'Odoo definida en altres mòduls, com per exemple, incidències, es crearà un mòdul tipus `ewan_isp_issue`, on es recolliran les adaptacions per tal que el sistema d'incidències ja definit en algun altre lloc es pugui integrar a la gestió de l'ISP. Un altre exemple serien les modificacions en documents de factures, vendes, albarans (`ewan_isp_account`, `ewan_isp_sale`, `ewan_isp_stock`)
+
+Noms
+----
+
+En general, per als models, el prefix que es farà servir és `ewan.isp`. Per exemple, per als contractes ISP, el nom del  model serà `ewan.isp.contract`; el del tipus de contracte `ewan.isp.contract.type`.
+
+Directrius de codificació
+-------------------------
+
+Es planteja fer servir la integració continua (CI) i les directrius de codificació de l'OCA. Cal escriure el màxim possible de tests. Cada programador haurà de responsabilitzar-se de què els seus *commits* passin els tests de la CI. L'objectiu final d'aquest vertical és ser desplegat automàticament en una plataforma SaS.
+
+El vertical ha de ser **multicompanyia**.
+
+Es defineixen 3 rols:
+
+*  **admin**, amb accés total.
+*  **tech**, amb accés només de lectura, però en alguns models o camps amb accés d'escriptura. Està pensat per a un tipus de tècnic de camp que pugui modificar atributs concrets de telèfons, fibra, etc.
+*  **user**, amb accés només de lectura.