organization

Organization

The organization of the repository reflects the long-lived nature of a features true specification. That is, the specification and design work related to a feature's implementation for a particular release often corresponds with only a portion of the entire feature's implementation. Moreover, feature's specification evolves over time as the requirements, architecture, and upstream specifications evolve.

The following table describes the organization of the top-level of the repository.

Top-level Directory Structure

features/	this is where all content goes
bin/, lib/	Ignore these. Contain helpers and their libraries
releases/	Ignore these. Contain auto-generated xref of features to releases

Feature Directory

---

Each feature is contained in its own directory. The organization of the features/${feature} directory, for some imagined ${feature}, is described in the following table:

Feature Directory Structure (e.g., features/${feature}/)

/overview.wiki	Top-level document aggregating all the sub documents
/xref	xref's to the JIRA epic(s) and confluence pages
/spec.wiki	High level architecture document
/diagrams	Source materials for diagrams and their generated documents (images)
/X.Y	Documents specific to the work done (or going on during) the X.Y release.	For example features/${feature}/3.3/ contains documents for the 3.3 release.
	/overview.wiki	Overview document aggregating all the release specific feature information
	/spec.wiki	Release specific feature specification
	/design	Release specific design documents
	/xref	xref's to the JIRA epic for the current release