Files
2026-07-11 14:56:10 +08:00

1.2 KiB

ADDED Requirements

Requirement: Documentation Reflects Implemented Capabilities

Implementation-facing documentation and API comments SHALL describe completed platform, run, frontend, and plugin capabilities as implemented when route registrations, clients, and tests already exist for those capabilities.

Scenario: Previously deferred route is implemented

  • GIVEN a route or capability is listed in implemented route catalogs or has active client/API tests
  • WHEN documentation or handler comments describe that same route or capability
  • THEN they SHALL identify it as implemented instead of as a gap, placeholder, or deferred behavior.

Scenario: Future work remains explicit

  • GIVEN a related capability is still intentionally out of scope
  • WHEN documentation is synchronized
  • THEN it SHALL keep that capability listed as future work without implying current implementation.

Scenario: Documentation-only synchronization

  • GIVEN stale documentation is corrected
  • WHEN the change is implemented
  • THEN it SHALL NOT introduce runtime behavior, API contract, frontend page, plugin SDK, or run executor changes.