NDragneelL9/the-undermine-bot

Documentation

Closed this issue · 0 comments

Write SSD documentation.
What should be inside Readme file:

  • Table of content
  • About application (or goal of the project)
  • Requirements (both functional and non-functional)
  • Glossary
  • Stakeholders
  • Design section with diagrams
  • Architecture with different viewpoints
  • Technology stack
  • Code quality and test coverage badges
  • Gettind started section
  • Contributing section