Who Owns This Heading? A Contract for AI-Drafted Docs

Описание и применение

Внедрите YAML‑контракт, назначающий владельца каждому заголовку документации, и скрипт‑гейт, который блокирует слияние, если разделы, принадлежащие человеку, не подписаны. Это гарантирует, что критические разделы проверяются людьми, а AI‑генерируемый контент не приводит к ошибкам в эксплуатации.

Задача

AI-generated documentation can contain critical operational or policy information that, if incorrect, leads to failures. Existing file-level ownership is too coarse, allowing human‑owned sections to be drafted by models without verification.

Результат

The workflow enforces clear ownership of documentation sections, preventing AI‑generated errors in critical operational content and ensuring human review before merge.

Рабочий процесс

• 1. Define a doc_ownership.yaml with rules mapping heading patterns to owners and reasons.
• 2. Generate documentation with an AI model, marking model_draft sections.
• 3. Add DOC‑OWN signatures to human_own headings by a reviewer.
• 4. Run ownership_gate.py to fail the build if any human_own heading lacks a valid signature.
• 5. Merge only after all gates pass, ensuring correct ownership and verification.

Доказательства

That failure was not a grammar problem. It was an ownership problem.

Источник

Unsigned, or signed with owner=model_draft on a human_own rule, is a gate failure.

Источник