Skip to content

Architecture

Give readers a stable mental model of the project.

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

System map

PartResponsibility
InterfaceAccepts user input and presents results
CoreApplies the project’s rules
AdaptersConnect external systems

Boundaries

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