search

USGS-WiM / whispers

Wildlife Health Information Sharing Partnership event reporting system(WHISPers) v2
Other
2 stars 1 forks source link

Author WHISPers technical specifications document #748

Open BlakeDraper opened 4 years ago

BlakeDraper commented 4 years ago

Place in WHISPers repo and wimfo repo.

BlakeDraper commented 4 years ago

Currently in progress, working w/NWHC for needs and specifics.

BlakeDraper commented 4 years ago

Update 4/15/20

We are most of the way through technical documentation efforts. Here is a review of the components and status.

Technical Specification doc

This is the main document with a list of items defined by NWHC. Aaron and Blake have collaborated on writing narratives for each item or pointing the reader to a supplementary document. This is all but done save for a few items needing input from @aaronstephenson

supplementary documents

Not one thing but a collection of diagrams, spreadsheets, or lists that meet the technical specs requested. May ultimately attach them as an appendix to the Technical Specification doc. These are finished and ready for NWHC review (also for WIM to review if desired)

current list:

  1. WHISPers System Overview
  2. WHISPers User Flow Application Overview and Module Hierarchy
  3. WHISPers Create Event User Flow
  4. WHISPers Search User Flow
  5. WHISPers Add New Custom Notification Flow
  6. WHISPers User Flow Symbology Key
  7. WHISPers Entity Relation Diagram
  8. WHISPers Business rules
  9. WHISPers Global Variables

API Documentation

This is an entire application that documents the WHISPers data API, created by Aaron and Lauren. @aaronstephenson or @lprivette can you provide an update on completion status?

Code docs (client)

this is a codebase documentation effort spearheaded by Lauren. It may serve the need NWHC has for some sort of codebase documentation, to supplement in-line code commenting. This is only available for the web client codebase.

If there is anything I missed, please comment. I am making a push to get this entire body of components out for NWHC review within a week so that once Effort 2 is moved to production, we can move toward a proper handoff until further Efforts are pursued.

aaronstephenson commented 4 years ago

I added content to the Technical Specs that had my name on it.

I am still working on the API Docs. I estimate 40 hours left.