JangasCodingplace / kumon-math-app

https://kumon-math-app.readthedocs.io/
GNU General Public License v3.0
0 stars 0 forks source link

Document the Kumon Learning Method for "kumon-math-app" #1

Open JangasCodingplace opened 1 year ago

JangasCodingplace commented 1 year ago

Summary

Develop a markdown-based documentation that outlines and explains the Kumon learning method for the benefit of our development team, especially junior members.

Background:

While the kumon-math-app will use the Kumon learning method as a foundational approach, there's a need for a clear and concise documentation that team members can refer to, ensuring everyone understands the core concept behind the app's functionality.

Objective:

Create a comprehensive documentation that covers:

Success Criteria:

Upon reading the markdown document, any team member, irrespective of their prior knowledge about Kumon, should:

Notes:

Ensure the document is beginner-friendly, given our team's experience level. Use clear and straightforward language. If there are technical terms related to Kumon, consider adding a small glossary or definitions section.

JangasCodingplace commented 1 year ago

TODO - dump to markdown