Dependencies
A List or Description of objects, components, plugins, or other dependencies that must be present for correct functionality, Eg. Rigidbody and Collider.
Give a brief description for what a dependency is required for if the dependency is a library or plugin
Description
Description of the properties and goals of the component.
Describe what the component does does, and high level information of how the component functions.
Architecture
Description of how a component should be structured in relation to other components. (Optional)
Describe necessary Subcomponents that my need to be created, as well as relevant Design Patterns and their use, and conventions to keep in mind.
Create and include a diagram if describing a complex system. (Optional)
Psuedocode / Code Snippets (Optional)
Description of component implementation in pseudocode.
May be useful when talking about an abstract component or concept.
// This is an example function that prints D string depending on the input bool
public static void Example(bool isExample) {
if (isExample) {
print("this is an example!");
}
else {
print("this is not an example");
}
};
Use Case / Examples
A description of how a component could/should be used.
Examples of use case should be included if the component requires input or manipulation by the user, or if meant to be extended.