CAWaterBoardDataCenter / CAWaterBoardDataCenter/SWAMP-Bioassessment-Reporting-Module

Draft Reporting Module Standard Operating Procedures (SOP) documentation

Open
#10 0 comments 0 reactions 1 assignee Claimed by @AHolder1 View on GitHub
documentation
Dominant language
R
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

- [x] Develop SOP using Quarto site

Example [Bioassessment CSCI SOP](https://www.waterboards.ca.gov/water_issues/programs/swamp/bioassessment/docs/20201220_consolidated_sop.pdf) for reference (i.e. Step-by-step Instructions for Using SWAMP Bioassessment Tools)

Example Quarto Sites: [Openscapes Approach Guide](https://openscapes.github.io/approach-guide/approach/) | [NASA Earthdata Cloud Cookbook](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/)

Sections:

- [x] Title page (Title, Welcome, Authors, Citation) **index.qmd**
- [ ] Table of Contents (on the right side of the site)
- [x] Introduction (Reporting Module Objectives/Purpose/Scope, Audience)
- [ ] Step-by-step Instructions
- [ ] Software requirements/recommendations (if any)
- [x] Overview; link to Data Management Plan; Insert workflow figure
- [ ] Step 1: Filter Datasets
- [ ] Step 2: Select & Calculate Reporting Metrics
- [ ] Step 3: Select & Export Reporting Output
- [ ] Output Interpretation & Use
- [ ] You've got your output - now what?!
- [ ] Provide some guidance/resources to help interpret output (links to metric docs)
- [ ] Use cases / how practitioners **_currently_** use these data (e.g. CDFW, ABL, SWAMP - CSCI, ASCI development)
- [ ] Use cases / how practitioners might want to use these data (Integrated Report, others?)
- [ ] Additional Resources
- [ ] Cheatsheets/Guides (written resources/fact sheets)
- [ ] Tutorials (recorded trainings, presentations/slide decks)
- [ ] Other useful links
- [ ] References (use Quarto features to create automatically!)
- [ ] Future Work
- [ ] In development (i.e. what are we actively working on now)
- [ ] Wish list (i.e. what would we like to improve/add/revise in the future)
- [ ] Contributing
- [ ] How we work
- [ ] Workflow
- [ ] Setup

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.