search

COVIDImpact / CovidImpact

COVID-19 is impacting countless small businesses across Canada, we all face uncertainty. Several colleagues and I asked what we could do to help? After a weekend of non-stop coding we’ve put together #CovidImpact, a FREE Small Business Care Package which features: A curated list of programs to help them through the crisis. Real-time news relevant to Canadian ventures Simulation tool to see how their business may be affected across various scenarios depending on how long COVID-19 drags out for. Together, Canadian businesses will get through this by supporting each other! CovidImpact is built in Vue with Javascript, HTML and CSS files. The project utilizes various Bootstrap-Vue components and newsapi.org to get the latest business news. The app is hosted on S3 and uses serverless functions for a mailchimp newsletter.
http://covidimpact.ca/
Apache License 2.0
3 stars 0 forks source link

Create Documentation for project #15

Open Aliserag opened 4 years ago

Aliserag commented 4 years ago

Overview: For a programmer reliable documentation is always a must. The presence of documentation helps keep track of all aspects of an application and it improves on the quality of a software product. Its main focuses are development, maintenance and knowledge transfer to other developers. Successful documentation will make information easily accessible, provide a limited number of user entry points, help new users learn quickly, simplify the product and help cut support costs. Documentation is usually focused on the following components that make up an application: server environments, business rules, databases/files, troubleshooting, application installation and code deployment.

What needs to be done:

  1. Create an MD file in the root directory called documentation that lists classes and components related to each page. Highlights the tech stack we are using, APIs, limitations, how deployment takes place etc.

Criteria of success:

  1. File added to root directory

Stakeholder: @Aliserag

NoirKomBatman commented 4 years ago

Do we need this? The best documentation is the code usually.

aPruner commented 4 years ago

IMO our app is actually simple enough such that @NoirKomBatman is correct. This maybe wouldn't be the case if we were building an API or something (in which case our users are developers who would be in need of API contract details), but since we're essentially a static site, we should be fine without any significant docs.

That being said, our docs (e.g: CONTRIBUTING.md and README.md) could use a little bit of extra work.

For example, our CONTRIBUTING.md doc could have more specific details about branch-naming schemes, code reviews, etc. There is lots of room for improvement here.

In addition, the root README.md could mention some details about the tech stack, how our serverless works, and reference the app/README.md file for details on local dev setup for the frontend.