Skip to content

Commit c42c779

Browse files
authored
Add toolkit overview presentation and executive summary (#9)
* Add toolkit overview presentation and executive summary - Add non-technical presentation explaining the toolkit's capabilities - Simplify language throughout for non-technical audiences - Add executive summary one-pager for stakeholders - Generate HTML slides using Marp for easy viewing - Add docs:slides npm script to regenerate slides - Update README with links to overview materials * Update presentation link and minor content changes * Simplify README links to presentation
1 parent 638e4e5 commit c42c779

File tree

5 files changed

+1034
-1
lines changed

5 files changed

+1034
-1
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This toolkit helps teams build consistent, well-documented APIs for safety net programs—enabling faster integration between benefits systems and reducing the technical barriers to improving service delivery.
44

5+
**New here?** Start with the [Executive Summary](./docs/presentation/executive-summary.md) for a one-page overview, or read the [Toolkit Overview](./docs/presentation/safety-net-openapi-overview.md) for a detailed walkthrough.
6+
57
## About This Repository
68

79
This is an evolving repository where Code for America stores integrated benefits API specifications for the different states we work with. The specifications are built on a common data model that captures the core concepts shared across safety net programs—applications, households, income, eligibility—while allowing for state-specific variations in terminology, program names, and data requirements.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Safety Net OpenAPI Toolkit
2+
## Executive Summary
3+
4+
### The Problem
5+
6+
Building technology for safety net programs is challenging. Each state has different terminology, program names, and requirements. Development teams waste time reinventing solutions, integration between systems is slow and error-prone, and organizations often become locked into specific vendors' proprietary systems.
7+
8+
### The Solution
9+
10+
The Safety Net OpenAPI Toolkit provides **pre-built, shared API definitions for benefits eligibility programs**. Instead of starting from scratch, teams build on a common foundation that captures core concepts—applications, households, income, eligibility—while allowing for state-specific customization.
11+
12+
### Key Capabilities
13+
14+
- **Shared API Definitions** — Ready-to-use specifications for common benefits data, built on industry standards that any vendor can implement
15+
- **Simulated APIs** — Fully functional test environments generated automatically, enabling frontend development without waiting for backend systems
16+
- **Ready-to-Use Code Libraries** — Pre-built integration code that catches errors early and speeds up development
17+
- **State Customizations** — Adapt the shared definitions for each state's terminology and requirements without duplicating work
18+
- **One-Command API Creation** — Define a new data type once, and automatically get a complete API with documentation, test environment, and code libraries
19+
20+
### Benefits
21+
22+
| For | Value |
23+
|-----|-------|
24+
| **Development Teams** | Start building immediately; consistent patterns reduce bugs and ramp-up time |
25+
| **Program Managers** | Faster delivery; reduced coordination overhead between teams |
26+
| **States & Agencies** | Customizable for local requirements; no vendor lock-in since any provider can implement the shared definitions |
27+
28+
### How It Works
29+
30+
1. Teams start with pre-built API definitions for common benefits data
31+
2. State-specific customizations adapt terminology and requirements
32+
3. Documentation, test environments, and code libraries are generated automatically
33+
4. Backend teams implement against clear specifications with automated verification
34+
5. Improvements to the shared foundation benefit all participating states
35+
36+
### Get Started
37+
38+
Visit the [Toolkit Overview presentation](https://codeforamerica.github.io/safety-net-openapi/presentation/safety-net-openapi-overview.html) for a detailed walkthrough, or explore the [repository on GitHub](https://github.com/codeforamerica/safety-net-openapi).
39+
40+
---
41+
42+
*Code for America — Enabling faster, more consistent API development for safety net programs.*

docs/presentation/safety-net-openapi-overview.html

Lines changed: 526 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)