As the application was iteratively constructed as I was conceiving it (it's mainly a prototype driven to production with increases in quality), some terms and concepts are poorly defined, and some of them are using the same names for radicaly different concepts.
This increases the cost of maintainance as I always have to research what a word means in the current context.
We should correctly define each term precisely, and have some kind of lexicon somewhere just in case.
This could change some routes on the API as the mapping will change.
Terms to change
Each term will be addressed by its corresponding current model, but the whole stack should be changed, to the mapping route for the controller, the service, the tests, the names of the views files, etc.
[ ] Models::Tools::Parameter is misleading as a parameter is applied on a module, not a tool. It should be renamed ParameterTemplate
[ ] Models::Tools::Port is misleading for the same reason and should be renamed PortTemplate
[ ] Models::Tools::Descriptor is too broad of a name and should be renamed ParameterConstraints as it is often referred to as constraints.
[ ] Models::Link should be referred to as Cable to avoid confusion with the more fine-grained InnerLink
[ ] Models::Category should be rename in Brand as category is too much broad as a term.
Context
Terms to change
Each term will be addressed by its corresponding current model, but the whole stack should be changed, to the mapping route for the controller, the service, the tests, the names of the views files, etc.
Models::Tools::Parameter
is misleading as a parameter is applied on a module, not a tool. It should be renamedParameterTemplate
Models::Tools::Port
is misleading for the same reason and should be renamedPortTemplate
Models::Tools::Descriptor
is too broad of a name and should be renamedParameterConstraints
as it is often referred to as constraints.Models::Link
should be referred to asCable
to avoid confusion with the more fine-grainedInnerLink
Models::Category
should be rename inBrand
as category is too much broad as a term.