Writing Documentation For Designers - StudioAspen/AAAGame2023-2024 GitHub Wiki
- Description of WHAT the thing is
- Description of unclear visual aspects (things like what gizmos represent)
- How to use it
- List of adjustable variables / components
- Variables like max health, speed, and damage
- Components like, the position/size of colliders, child objects, references
- Location of relevant prefabs, just include the path to the folder Ex:
/Prefabs/Enviornment
- List of adjustable variables / components
- Other
- Any screenshots you think will help
- Any other notes you find relevant
- Things like known issues, work arounds, limitations