How to Use the Starter Kit¶

Purpose¶

This page explains the recommended workflow for using the ETIS Engineering Platform Starter Kit.

The Starter Kit is most effective when used as a guided engineering process, not as a file library.

The adoption workflow¶

1. Understand

Read the Platform Overview so you understand the ETIS purpose, repository model, and evidence-centered approach.

2. Orient

Begin with ES-100. It explains the engineering journey, core principles, stage map, glossary, and readiness model.

3. Work the stages

Move through ES-101 to ES-114 in order unless you are intentionally adapting the platform for an existing project.

4. Use templates

Copy templates into docs/project-workspace/ only when they support real engineering work and evidence production.

5. Compare examples

Use LMU/COICP examples to understand what completed evidence can look like without copying blindly.

6. Review before advancing

Use readiness gates to decide whether the next stage can begin responsibly.

The working pattern¶

Read stage guidance
      ↓
Copy the relevant template
      ↓
Complete project evidence in docs/project-workspace/
      ↓
Review against the readiness gate
      ↓
Advance or return for correction

Where project evidence goes¶

Because this repository is published with MkDocs, the top-level docs/ directory is the site publication root. Completed project evidence belongs under docs/project-workspace/.

docs/project-workspace/
├── vision/
├── requirements/
├── planning/
├── architecture/
├── design/
├── implementation/
├── integration/
├── testing/
├── release/
├── operations/
├── deployment/
├── monitoring/
├── stewardship/
└── governance/

What you normally edit¶

In a cloned Starter Kit project, most day-to-day engineering work should occur in docs/project-workspace/.

The rest of the repository functions primarily as the engineering reference library:

Repository Area	Normal Use
`docs/platform/`	Learn how to adopt the Starter Kit.
`docs/engineering/`	Read Engineering Stage guidance.
`docs/template-library/`	Copy reusable templates.
`docs/examples/`	Compare completed reference examples.
`docs/project-workspace/`	Create and maintain project evidence.

Adoption paths¶

Situation	Recommended path
New to ETIS	Platform Overview → ES-100
New project	ES-100 → ES-114 in order
Existing project	Inventory existing evidence, then enter the earliest weak stage
Instructor use	Platform Overview → ES-100 → selected stages/modules
Evaluation only	Lifecycle → Repository Tour → Examples
Organization adoption	Repository Tour → Templates → ES-100 pilot cycle

Common Pitfall

Do not jump directly to implementation because the repository has templates. ETIS starts by reducing uncertainty before code is written.

Engineering Insight

The Starter Kit accelerates engineering discipline; it does not replace engineering judgment.

Continue to Engineering Lifecycle

See how the stages form a complete engineering cycle.

Continue to Lifecycle →