Skip to content

[Content] Start the Dam Screening Tool User's Guide with the Dashboard - #161

Draft
AdamGohs wants to merge 4 commits into
mainfrom
docs/new/dst-users-guide
Draft

AdamGohs wants to merge 4 commits into
mainfrom
docs/new/dst-users-guide

Conversation

@AdamGohs

Copy link
Copy Markdown
Collaborator

Description

Starts the Dam Screening Tool User's Guide from scratch (the earlier unreviewed draft was removed in #144), beginning with the Dashboard. This is a draft to show the direction the guide will take.

In this PR

  • Front matter: Document Info, Version History, Preface.
  • Chapter 3, Getting Started, covering the Dashboard:
    • the My Screenings, My Reviews and Search Catalog tabs
    • creating a screening, including the NID dam search and USACE dams
    • copying and renaming screenings
    • managing the screening team
    • requesting access to other screenings
  • Seven screenshots with numbered callouts and full alt text.
  • The guide is registered as an active draft, with sidebar_label "Dam Screening Tool User's Guide".

How the guide is built

  • Organized by the screening workflow, not the code. One chapter per nav tab, an H2 per page or sub-tab, an H3 per page section.
  • Cross-cutting behavior is explained once. Auto-save, automatic calculation, message banners, verification, input lock, editing conflicts, grids and Submission Readiness get one shared chapter (Chapter 4, Working in DST), and every page chapter links to it instead of repeating it.
  • Planned chapters:
    • 02 Introduction
    • 03 Getting Started (sign-in and Profile still to come)
    • 04 Working in DST
    • 05 Screening Information
    • 06 Hazards
    • 07 Dam Information
    • 08 Cross-Section Editors
    • 09 Failure Mode Screening and Selection
    • 10 Failure Mode Evaluation (everything the PFM pages share)
    • one thin chapter per PFM
    • User-Defined PFM
    • Consequences
    • Risk Analysis
    • Major Findings
    • Documents
    • Review
    • References and appendices (acronyms, glossary, PFM quick reference)
  • Every input is documented: exact label, whether it is required, and one sentence on what it feeds. Methodology stays in the Technical Reference Manual, and engineering judgment stays in the Applications Guide.
  • Screenshots are reproducible and use only fictional data. They were captured at 1920×1080 from a scratch DST stack seeded with fictional "Example" dams and generic seed accounts, never from a working database. Each one is recorded in a shot list so it can be recaptured when the UI changes. Callouts are steel blue, never red.

Document scope

  • Document: Dam Screening Tool User's Guide
  • Document location (doc_location, or -): web-applications/dst/users-guide

Related issue(s)

None.

Validation

  • I previewed the change locally or through the PR preview
  • I ran the checks appropriate to this change
  • I updated version history when the document revision warrants it (initial version)

DOCS_MODE=prod npm run build passes, and the chapter was checked in a local build of the site.

Review notes

New document: Lane 1. Draft, opened for early feedback on structure, tone and figure style before more chapters are written. References to Chapter 4 (Working in DST) and Chapter 27 (Review) are plain text until those chapters exist.

Adds the guide's front matter and a Getting Started chapter covering the
Dashboard: My Screenings, My Reviews, Search Catalog, creating, copying and
renaming screenings, and managing the screening team, with screenshots
captured from fictional example screenings. Registers the guide as an
active draft.
@AdamGohs
AdamGohs deployed to review-control October 17, 2026 13:53 — with GitHub Actions Active
@usace-rmc-docs-review

usace-rmc-docs-review Bot commented Oct 17, 2026 •

Copy link
Copy Markdown

Review workflow

Purpose: content · Classification: awaiting administrator assignment
Document: not selected

Stage Reviewer Status

Next: Administrator: classify this PR

Review preview: https://usace-rmc.github.io/RMC-Software-Documentation-Previews/pr-161/
Preview revision: 8071e731ca4d71dc0adc98568dd561a39d6271fe

Completed stages persist until an administrator restarts them. Replies and resolved threads are not approval requirements. Use /review ready to request re-review within an active stage.

@usace-rmc-docs-review usace-rmc-docs-review Bot changed the title Start the Dam Screening Tool User's Guide with the Dashboard [Content] Start the Dam Screening Tool User's Guide with the Dashboard Oct 17, 2026
@usace-rmc-docs-review usace-rmc-docs-review Bot added purpose:content stage:needs-lane Awaiting admin to assign a review lane labels Oct 17, 2026
@usace-rmc-docs-review

Copy link
Copy Markdown

@USACE-RMC/docs-admin — classify this PR with /review classify <lane> <document|->. Builds run while classification is pending.

@AdamGohs
AdamGohs deployed to review-control October 19, 2026 13:32 — with GitHub Actions Active
@AdamGohs
AdamGohs deployed to review-control October 19, 2026 15:02 — with GitHub Actions Active

This branch was successfully deployed

1 active deployment
review-control — 8071e731 Deployed Oct 19, 2026 by AdamGohs via control #632
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

purpose:content stage:needs-lane Awaiting admin to assign a review lane

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant