This is the multi-page printable view of this section. .

Introduction

Understand the project and the ideas behind it.

Start here when the project is new to you.

1 - Project Overview

State what the project does, who it serves, and why it exists.

Replace this page with the shortest useful explanation of your project.

Describe the problem in the reader’s language. Avoid implementation details until the reader understands why the project matters.

Explain what a successful user can do after adopting the project.

Tip

A strong overview helps readers decide whether to continue in less than two minutes.

Give readers a stable mental model of the project.

Document the few components a contributor must understand before making a change.

Part	Responsibility
Interface	Accepts user input and presents results
Core	Applies the project’s rules
Adapters	Connect external systems

Name what the project deliberately does not own. Clear boundaries prevent documentation from promising more than the software provides.