Skip to content

Open-source project documentation pattern

The Open-source project documentation pattern refers to a documentation strategy where the reference application for a project is directly utilized as its primary documentation source.^[600-developer-spring-spring-sagan.md]

In this pattern, rather than maintaining separate, static guides, the functional software acts as a "reference application" that demonstrates the project's intended use and architecture^[600-developer-spring-spring-sagan.md]. This approach is exemplified by projects like spring-io/sagan, which serves the dual purpose of being the live Spring.io website and the reference implementation for Spring's documentation^[600-developer-spring-spring-sagan.md].

Sources

^[600-developer-spring-spring-sagan.md]