Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Like the three laws of robotics, right now Magnolia CMS Concept Maps have three simple rules. I'll be honest and admit that these are more for convenience (i.e to keep things simple) and are any NOT based on any 'years of experience has taught us that this is the most fruitful approach' type of methodology...

...

Too many information bubbles and the map becomes confusing. The information should be relevant to Magnolia CMS. The Magnolia CMS rabbit hole is rich and wondrous enough; no need to show the visitor all around the whole of IT Wonderland. To draw an analogy, while a concept map of a 'car' might include 'chassis', it probably should not include 'chase'. (This rule seems pretty solid to me.)

2) Relevant

Keep the concept map relevant. Just because a topic is worth mentioning on a map doesn't mean that it deserves a map for itself. A good rule of thumb regarding the specificity of a possible map is 'take a step back'. Go up a level. Does a component merit a concept map? Or should component simply be a concept on a concept map called Template? Obviously everything is relevant. Instead of 'relevant' we could say 'appropriate'. (Again. This rule seems pretty solid too.)

3) Relational

Make things become 'obvious' through clarification: not just repeat the obvious. Second level concepts on a Magnolia CMS Concept Map should be no more than one step removed from the central-concept. There's nothing wrong with having sub-levels of conceptually related topics, but a concept is in Magnolia CMS, then that concept is in some way related to everything else in Magnolia, so there's no need to expand the conceptual circle too far. (This rule could be amplified a bit. Maybe by relational we could mean the more obvious 'it explains the relationship between the different object, elements and nodes on the map.

Modules as a starting point

As each module is a discrete unit the most obvious place to start with a Magnolia CMS Concept Map is with the Modules. For now the maps reside on the wiki, but in the long run they could make it to the official documentation. For example on the CAS module page the first thing a viewer sees is a concept map with the salient points/ideas related to CAS, they can then use the map to navigate to the LDAP page or to a page about ACLS.

  • Enhancements:
    • Colour-coded nodes indicating that a page or component exists in our documentation.
    • Coloured lines indicating status type of item
    • Directional arrows for dependencies or to indicate hierarchy. So Template > Component, Page, Area > Web page

Phased Approach

Phase 1 - Static Concept Maps

...

Phase 3. - Fully Interactive Magnolia CMS Concept Map

SearcableSearchable, graphically pleasing, the fully interactive Concept Map allows a user to look around the Documentation, in the shape of an interconnected information sphere. Great for touch screen devices.