Creating Docs with Templates

# A Brief, but Descriptive One Line Title
 
## Description
 
<!--A short paragraph describing the issue with important keywords, files,
and variables included if possible -->
 
## Relevant Code
 
<!-- This section should contain complete sections of relevant code.
It should not have placeholder blocks in it when it is filled out.
Please describe why each code block is relevant and what it is doing. -->
 
## Hidden Assumptions
 
<!-- This section should make explicit any assumptions described in the description
 and based on your searched for code results.-->
 
## Implementation Plan
 
<!-- This should describe thoroughly enough for a junior engineer to take up this
ticket and to implement this ticket. Think about how data moves through the application,
design patterns and most importantly how the existing code will be modified and what new
code will be added. -->
 
## Acceptance Criteria
 
<!-- Define when this ticket is done. Make the acceptance criteria explicit -->
 
## Testing Plan
 
<!-- Provide a testing plan. A list of concrete cases to be tested, and an approach to
testing, both for unit and integration tests if applicable. Be explicit about mocking
and test data requirements. -->
 
## Code Complexity
 
<!-- Please describe how the modified code is connected to other chunks of the code.
Show how complex this issue is and what things this will touch in order for it to work. -->

# A Brief, but Descriptive One Line Description of the Issue
 
## Description
 
<!--A short paragraph describing the issue with important keywords, files,
and variables included if possible -->
 
## Relevant Code
 
<!-- This section should contain complete sections of relevant code.
It should not have placeholder blocks in it when it is filled out.
Please describe why each code block is relevant and what it is doing. -->
 
## Potential Causes
 
<!--This section should outline the relevant code and how they could potentially
 be related or cause the bug reported. -->
 
## Fixes
 
<!--This outlines potential fixes to the code given the described potential problems above. -->

# File/Class name Documentation
 
## How File/Class Works in Isolation
 
<!-- This outlines how the given File or Class given in the title of the template works by itself.
It lists major functions, variables and things this File or Class depends on that are imported.
Then it lists and describes high level functions class names, and variables that it exports
that other classes use.
 
Finally, this section describes what each of the above do in the context of this class.-->
 
## How File/Class Works with the Rest of the Codebase
 
<!--Given the previous section, this section describes in detail what other parts of
the codebase File/Class relies on and how those sections work together.
This section also outlines in detail what other parts of the codebase rely on this code and how those
sections work.
In other words, this section states clearly what the references to this class are and what the dependencies are.
-->

#### Title: [Product/Feature Name]
 
## Overview
 
<!-- Summarize the product or feature, including its purpose, the problem it solves,
or the opportunity it addresses. -->
 
## Objectives
 
<!-- List the primary objectives this product or feature aims to achieve,
including specific success metrics. -->
 
## Background and Strategic Fit
 
<!-- Explain the product or feature's fit within the overall strategy, its market relevance,
and the rationale for its development timing. -->
 
## Assumptions
 
<!-- Identify any assumptions that underpin the development of this product or feature. -->
 
## Requirements
 
### Functional Requirements
 
<!-- Detail the functionality that the product or feature must include, specifying what needs
to be built. -->
 
### Non-Functional Requirements
 
<!-- Describe performance-related requirements, including scalability, performance,
 usability, security, and compliance. -->
 
## User Stories
 
<!-- Provide user stories to convey how different user types will interact with the
product or feature, ensuring the
development team understands the user perspective. -->
 
## Scope of Work
 
<!-- Outline the tasks, sub-tasks, and milestones necessary to complete this product or feature. -->
 
## Out of Scope
 
<!-- Define what is not included in this project to prevent scope creep. -->
 
## Dependencies
 
<!-- List any dependencies that could impact the development timeline, including
both internal and external factors. -->
 
## Timeline
 
<!-- Provide an estimated project timeline, including key milestones and deadlines. -->
 
## Success Metrics
 
<!-- Define the metrics that will measure the success of the product or feature post-launch. -->
 
## Open Questions
 
<!-- List any unresolved questions that need to be addressed before development can proceed. -->
 
## Revision History
 
<!-- Track revisions to this document, including dates and a brief description of changes. -->