Skip to content

docs: narrow focus to ODS L1 + AI Disclosure per community review#4

Merged
shenxianpeng merged 1 commit into
mainfrom
chore/narrow-focus-l1-ai-disclosure
May 25, 2026
Merged

docs: narrow focus to ODS L1 + AI Disclosure per community review#4
shenxianpeng merged 1 commit into
mainfrom
chore/narrow-focus-l1-ai-disclosure

Conversation

@shenxianpeng
Copy link
Copy Markdown
Contributor

Summary

Implements key recommendations from detailed community review. The core change: narrow ODS positioning from "AI era delivery governance standard" to "a lightweight, machine-readable standard for AI-aware pull request and delivery metadata."

Key Changes

1. Repositioning (README, docs/index)

Before After
"Machine-readable delivery governance evidence for the AI era" "A lightweight, machine-readable standard for AI-aware pull request and delivery metadata"
Full 9-module map as primary surface ODS L1 + AI Disclosure as the wedge; 04-09 as experimental
"AI-native" design principle "AI-aware, not AI-obsessed"
No disclaimer about scope "ODS does not prove the code is correct. It proves the delivery process contains the minimum structured evidence needed for humans and machines to review the change responsibly."

2. AI Change Review (spec/04) — rewritten

Removed AI% as a compliance metric and replaced with qualitative fields:

  • ai_assistance_level: none | assisted | generated | agentic
  • ai_scope: docs | tests | implementation | refactor | security-sensitive | release
  • risk_level: low | medium | high
  • Review levels (L1/L2/L3) driven by assistance level, not line-count percentage
  • ai_contribution_percentage retained as optional signal, not a hard gate
  • Status: Candidate → Experimental

Includes explicit rationale: "Why Not AI Percentage?" section documenting 5 reasons it's unreliable.

3. New: PR Template (examples/ods-pr-template.md)

Copy-paste template for .github/PULL_REQUEST_TEMPLATE.md with:

  • Summary, Type, AI Disclosure, Changes, Testing, Risk Assessment, Checklist
  • Before/after comparison table
  • CLI and validation commands

4. New: Before & After Case Study (docs/case-study.md)

Concrete comparison with reviewer experience metrics:

  • Before: "fix stuff", empty body, 3-5 clarification questions, hours to review
  • After: structured metadata, 0 clarification questions, minutes to review
  • Honest "What ODS Proves / Doesn't Prove" table
  • Surgery/aviation checklist analogy

5. Branch Naming (spec/01)

AI prefix (feature/ai-*) remains optional convention — JSON metadata is the primary attribution mechanism.

6. ROADMAP restructured

  • Added Experimental status category
  • Modules 04-09: Candidate → Experimental
  • M2 renamed to "AI-Native Tooling" (tools built, modules stay experimental pending adoption signal)
  • M3 renamed to "L1 Stable + Early Evidence"
  • M4 renamed to "Governance Model"
  • New M2 goal: "Adoption signal: 2+ teams using ODS L1 with positive feedback"

Design Philosophy

The wedge is: make AI-generated PRs easier to review, not to prove a full governance framework. Checklists don't perform surgery — they ensure the team has the information they need before they start.

Type

  • Documentation

Major changes based on detailed community feedback:

README — repositioned:
- Title: "A lightweight, machine-readable standard for AI-aware
  pull request and delivery metadata" (not "governance evidence
  for the AI era")
- Core disclaimer: "ODS does not prove the code is correct. It
  proves the delivery process contains the minimum structured
  evidence needed for humans and machines to review the change
  responsibly."
- Before/After comparison showing concrete value
- Modules 04-09 marked Experimental (not Candidate)
- Design principles updated: "AI-aware, not AI-obsessed"

AI Change Review (spec/04) — rewritten:
- Replaced AI% with qualitative ai_assistance_level:
  none | assisted | generated | agentic
- Review levels driven by assistance level, not percentage
- ai_scope: docs | tests | implementation | refactor |
  security-sensitive | release
- risk_level: low | medium | high
- Status: Experimental (demoted from Candidate)

Branch Naming (spec/01):
- AI prefix in branch names remains optional convention
- Primary mechanism is JSON metadata

CI Failure (spec/05):
- Status: Experimental (demoted from Candidate)

ROADMAP:
- Experimental status category added
- M2 renamed to "AI-Native Tooling" (tools built, modules
  experimental pending adoption signal)
- M3 renamed to "L1 Stable + Early Evidence"
- M4 renamed to "Governance Model"

New files:
- examples/ods-pr-template.md — copy-paste PR template
- docs/case-study.md — before/after comparison with metrics

Docs index, get-started updated to narrow focus
@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label May 25, 2026
@shenxianpeng shenxianpeng merged commit 24cb221 into main May 25, 2026
2 checks passed
@shenxianpeng shenxianpeng deleted the chore/narrow-focus-l1-ai-disclosure branch May 25, 2026 19:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant