Model-Drafted vs Human-Owned: A Contract for Generated Docs

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

Документы, генерируемые моделью, теперь проходят проверку на наличие авторитетных утверждений без подписи человека, благодаря контракту ownership.json и скрипту проверки.

Задача

Generated documentation can include authoritative language (guarantees, deadlines, contact paths) that no human has signed off on, creating unowned commitments.

Результат

Docs are now generated with clear ownership boundaries, preventing accidental commitments and ensuring human review of any authoritative language.

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

• 1. Define ownership.json with files, human_owned, draftable, and authority_phrases.
• 2. Add HTML comment markers (docs-own) to each heading in the target Markdown file.
• 3. Run ownership_check.py in CI before invoking any doc generator.
• 4. The checker verifies all ids exist, human sections have signed_by, draftable sections lack authority phrases, and no unknown ids are present.
• 5. If any rule fails, the CI job fails, preventing generation of unowned authoritative text.

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

The checker can parse it. Rendered Markdown ignores it.

Источник

Fail if generated docs speak with unowned authority.

Источник