Write introduction document about Project Noise Meter

[vgotcheva]

We need to write a document that introduces Project Noise Meter to everyone interested in learning about it or contributing to it.

[NewJerseyStyle]

I think we can build an index in this repo, and split the document for three part:

1. Developer document
2. User document
3. Learning material for DIY lover

Therefore, we will be able to maintain a loose organization with some support from project management tools and provide possibility for developer, user, learner and allow other idea to join the discussion.

Index (Table of Content)

README.md

• Introduction of the latest development
• CHANGELOG news of all related repository
• Collect issues on requirement level / new idea
• Index of other repository and documents
• Raise new idea for noise meter in Civic Tech event (30 sec pitch section)

Developer document

• Information needs to know for building the production level deliverable
• Project plan and point of contact for different resources
• Deliverable list
• Quality control HOW-TO
• Maintenance task list
• Project deliverable feature list
• Architecture design and other UMLs (Project Spec)

User document

• New issue HOW-TO
• Ask for help HOW-TO and WHERE
• Tutorial for setup
• Tutorial for different user scenarios
• Tutorial for common troubleshooting

Learning material for DIY lover [HOW-TO build your own noise meter]

• WHERE and HOW to get hardware devies
• WHY these hardware devices
• WHAT do the hardware do in project
• WHAT do we need for software part
• WHERE are the codes
• WHY those code
• WHAT do each part of the code do
• HOW to integrate them
• WHAT-IF change some of the lines in code

[NewJerseyStyle]

@vgotcheva Can you help to check with Gabe if the proposed document structure align with the benefit of all related stakeholders (developers, contributors, users, learners, maybe beneficial owners, and other related personals)?

[NewJerseyStyle]

https://miro.com/app/board/uXjVNwNt7UU=/

Service blue print, a good component for developer document