01 / SaaS app
SaaS app OKF prompt
Generate an OKF bundle that explains product metrics, subscription data, dashboards, and recurring operating reviews.
Folder structure
okf/
|-- index.md
|-- log.md
|-- metrics/monthly-recurring-revenue.md
|-- metrics/churn-rate.md
|-- tables/subscriptions.md
|-- dashboards/revenue-dashboard.md
`-- playbooks/revenue-review.md
Copy-paste agent prompt
text
Create an OKF bundle for my SaaS app.
First inspect the repository, product docs, database schema, analytics notes, and dashboards that are available to you. Then create an `okf/` folder that helps humans and AI agents understand the app's core commercial knowledge.
Use this folder structure as the starting point:
okf/
|-- index.md
|-- log.md
|-- metrics/monthly-recurring-revenue.md
|-- metrics/churn-rate.md
|-- tables/subscriptions.md
|-- dashboards/revenue-dashboard.md
`-- playbooks/revenue-review.md
Declare `okf_version: "0.2"` in the root index. For every non-reserved concept file, add YAML frontmatter with `type`, `title`, `description`, `resource`, `tags`, `generated`, and `sources` when source material exists. Use `Metric`, `Table`, `Dashboard`, and `Playbook` types where appropriate. Record the real producer in `generated.by` and the last meaningful change in `generated.at` as an ISO 8601 datetime with a UTC offset. Add `verified`, `status`, and `stale_after` only when the available evidence supports them.
Write concise Markdown bodies that explain the concept, where the source lives, how it is calculated or used, known caveats, and related files. Use standard Markdown links. Prefer bundle-relative links such as `/tables/subscriptions.md` for spec alignment, or use ordinary relative links consistently when the bundle must render without an OKF-aware resolver. Do not invent business rules, SQL logic, or dashboard behavior. If a fact is unknown, add it to `okf/log.md` under "Questions for maintainers".
When finished, summarize every file created and tell me how to validate the folder with the OKF validator.