Update the current documentations and convert them to pdf - Githubissues

COS301-SE-2024 / The-Republic

Imagine a fusion of ‘Eskom se Push’ and ‘X’. The Republic allows users to raise concerns and spread awareness about government services through incident reports, with cool data visualizations providing a dynamic overview of public sentiment on service delivery.

https://the-republic.co.za/about

9 stars 2 forks source link

Update the current documentations and convert them to pdf #295

Closed ShamaKamina closed 1 month ago

ShamaKamina commented 2 months ago

Architectural Doc

Ensure the information is related to our system in terms of the different patterns. once done convert it into a pdf and link it on our readMe

Coding Standards

Ensure the doc documents the file structure and code of our repo
Ensure it describes the conventions and styles to ensure a uniform style, clarity, flexibility, reliability and efficiency of out code
Once done convert it to pdf and link it on our ReadMe

Testing Policy Doc

The testing policy document should describe the procedure we are following for testing.
Point to your git repository of test cases and test reports.
See chapter 18 of the textbook
Once done convert to pdf and link to readMe

Techinical Installation Manual

Ensure the manual is up to date and has sufficient information
Once done convert to pdf and link to readMe