Site Specification

As already mentioned, an Ingeniux CMS project begins with the creation of an organizational document that serves as a blue print for all development. This blue print may be a formal site specification, a less formal technical definition document, or other organizational document. The spec helps ensure the end product meets business needs. Typically, the documentation of the spec follows a needs assessment, where the business needs for all schema types are identified.

A typical specification contains the following sections:

  • Version History - Gives the current version of the document. This can be useful information if the document is passed back and forth between parties for adjustment.
  • Access Information - Lists URLs and a username and password for logging into the site.
  • How to Read This Document - Explains the document layout.
  • Site Implementation Overview - Lists page and component types to be defined in the document.
  • Site-Wide Conventions - Explains features such as site-wide navigations, search functionality, forms, header and footer information, SEO information, and special functionality. This area is also a great place to discuss any integrations with third party systems. If you are working with a form system, event management system, social media feeds, or anything that requires connection to another system, define that here so that it is a known quantity. The site-wide convention area is also a record of where to find the credentials to access these systems and who will maintain the relationship with third-party contributors.
  • Page Types - Defines schemas for each page type.
  • Components - Defines schemas for each component type.
  • Site Map - Matches information architecture to page types. The site-wide conventions area includes a site map outlining primary pages in the site to aid in building out the site tree using newly created schemas.
  • Taxonomy Strategy - Outlines taxonomy use across the site.

Schemas define the pages, assets, and components used to build out a site. The schema definition includes the name of the schema and the elements it contains. Each element in the schema has a corresponding field on the Edit tab in the CMS. The Edit tab fields are where content contributors enter site content.

This section includes: