Skip to content

Example: application overview

Doc gen writes docs/application/overview.md once per web front end to state what the application is for, who uses it, and which libraries own each capability.

What reviewers should check

  • The capability matrix names an owning library for every capability, and each library links to a docs/libraries/<slug>/overview.md page this run actually generated.
  • The Users table gives each role a concrete description and use cases drawn from real screens, not a restatement of the role name.
  • ## Related documentation lists the sibling application pages and omits overview.md itself.
  • ## Sources is the final section and points at real project files such as the .vbproj and Web.config, not at analysis output.
  • Frontmatter carries a filled owner and a real last_reviewed date.
  • Section order matches the template: Purpose, Users, Capability matrix, Related documentation, Sources.

Example

The document below is a complete, correct overview.md for a fictional application.

View rendered example — the same document as a real page, so you can compare rendering as well as source.

---
title: Application overview
summary: Purpose, users, capabilities, and capability matrix for the application.
status: draft
owner: Claims Intake Team
last_reviewed: 2026-09-09
---

# Application overview

Claims Intake (`SAIF.Claims.Intake`) is an ASP.NET Web Forms application running
on .NET Framework 4.8. SAIF claims staff use it to record newly reported
workers' compensation injuries, search for existing claims so duplicates are not
opened, and triage each new claim to the correct adjuster queue. The application
hosts nine screens under `Claims/` and `Claimants/`, authenticates users with
Windows integrated authentication, and reads and writes all claim data through
the claims web service rather than a direct database connection.

## Purpose
- Record new workers' compensation claim reports taken by phone, fax, or the
  employer portal, and assign each one a claim number.
- Search existing claims by claim number, claimant, employer policy, or
  date-of-injury range before a new claim is opened, so duplicate claims are
  avoided.
- Triage each newly recorded claim to an adjuster queue based on injury type,
  claim severity, and the employer's assigned service team.
- Maintain claimant demographic records shared across claims, including name,
  address, and employment history.
- Give intake supervisors a read-only view of closed claims for reference during
  a new claim conversation.

## Users
| User role | Description | Primary use cases |
| --- | --- | --- |
| Intake specialist | Claims staff who take first reports of injury from employers, claimants, and medical providers | Search for an existing claim, record a new claim report, correct claimant demographics before submission |
| Claims triage coordinator | Staff who review newly recorded claims and route them to an adjuster queue | Review the daily intake queue, reassign a claim to a different adjuster team, flag a claim as urgent |
| Intake supervisor | Team leads who monitor intake volume and resolve escalations | Review open and closed claims read-only, reopen a claim submission returned by triage, run the daily intake summary |
| Claims service desk | Support staff who assist adjusters with intake corrections | Look up a claim by number, verify claimant identity, correct a policy number recorded in error |

## Capability matrix

| Capability | Owning library/libraries | Description |
| --- | --- | --- |
| Claim search and duplicate detection | [SAIF.Claims.Intake.Search](../libraries/saif-claims-intake-search/overview.md) | Builds search criteria from the Claim Search screen, calls the claims web service, and applies the 250-row result cap |
| Claim report capture | [SAIF.Claims.Intake.Capture](../libraries/saif-claims-intake-capture/overview.md) | Assembles a first report of injury from the New Claim screen and submits it to the claims web service |
| Claimant demographics | [SAIF.Claims.Intake.Claimants](../libraries/saif-claims-intake-claimants/overview.md) | Reads and updates claimant name, address, and employment records shared across claims |
| Input validation | [SAIF.Framework.Validation](../libraries/saif-framework-validation/overview.md) | Validates claim numbers, policy numbers, date ranges, and required-field combinations before any service call |
| Triage routing | [SAIF.Claims.Intake.Triage](../libraries/saif-claims-intake-triage/overview.md) | Evaluates injury type, severity, and employer service team to select the destination adjuster queue |
| Claims service access | [SAIF.Claims.Intake.ServiceProxy](../libraries/saif-claims-intake-serviceproxy/overview.md) | Wraps the generated claims web service proxy, applies credentials, timeouts, and retry handling |

## Related documentation
- [Application index](index.md)
- [Architecture](architecture.md)
- [Dependencies](dependencies.md)
- [Configuration](configuration.md)
- [Operations and processes](operations-processes.md)
- [Business rules](business-rules.md)
- [Security and authorization](security-authorization.md)
- [Data model](data-model.md)
- [Tech debt](tech-debt.md)

## Sources
- src/SAIF.Claims.Intake/SAIF.Claims.Intake.vbproj
- src/SAIF.Claims.Intake/Web.config
- src/SAIF.Claims.Intake/Global.asax.vb
- src/SAIF.Claims.Intake/Claims/ClaimSearch.aspx.vb
- src/SAIF.Claims.Intake/Claims/ClaimNew.aspx.vb
- src/SAIF.Claims.Intake/Claimants/ClaimantSearch.aspx.vb