Skip to content

bug(general-doc-constraints): prose wrapping rule ambiguity causes pre-wrapped output #100

@KemingHe

Description

@KemingHe

Related

What Happened?

Expected

AI agents produce continuous-line paragraphs with no hard newlines within a paragraph, letting editors and viewers handle visual wrapping at render time.

Actual

AI agents interpret the prose rule as an instruction to insert line breaks that simulate how an editor would visually wrap text (typically at 70-80 character width), producing pre-wrapped output that defeats the purpose of the rule.

The v1.1.0 prose rule reads: "Never break a sentence across lines with a hard newline; multi-sentence paragraphs belong on one continuous line since editors and viewers handle visual wrapping."

Two sources of ambiguity:

  • The phrase "editors and viewers handle visual wrapping" reads as a description of wrapping behavior rather than a prohibition against hard newlines. AI agents infer they should produce output that looks like what an editor would visually render, including line breaks at natural wrap points.
  • The Output quality checklist item "Soft-wrapped bullets or prose" is listed under "Check For" without indicating whether soft-wrapping is the desired state or a problem to flag. Since the checklist context implies items are problems, this contradicts the prose rule which wants soft-wrapping (no hard breaks).

Steps to Reproduce

  1. Apply General Doc Constraints v1.1.0 to any multi-sentence prose generation task (e.g., email drafting, report writing).
  2. Observe that generated paragraphs contain hard line breaks at approximately 70-80 characters despite the rule prohibiting them.

Environment

  • Component: General Doc Constraints (shared footer v1.1.0)
  • Affected consumers: documentation-review skill Output quality checklist, all skills importing GDC

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions