Provide an overview of your project, library, or application. Explain what it does and the problem it solves.
List the primary goals and objectives of your project.
Define the boundaries of your project, library, or application.
List any dependencies required for your project, library, or application.
Give a high-level overview of the architecture of your project.
- Functionality: Describe the purpose of this component.
- Interface: Discuss how this component interacts with others.
- Functionality: Describe the purpose of this component.
- Interface: Discuss how this component interacts with others.
If your project provides an API, specify the endpoints, methods, and responses here.
Discuss the performance considerations or requirements of your project, library, or application.
Provide information on how the project handles security, if applicable.
Discuss any known limitations or constraints.