Skip to content

DOCS-1868 - Add plain-tone rules for docs and human-facing comments - #7100

Closed
kimsauce wants to merge 1 commit into
mainfrom
DOCS-1868
Closed

DOCS-1868 - Add plain-tone rules for docs and human-facing comments#7100
kimsauce wants to merge 1 commit into
mainfrom
DOCS-1868

Conversation

@kimsauce

@kimsauce kimsauce commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator

Purpose of this pull request

Adds a plain-tone standard so Claude's output reads less like generic AI: no em dashes, no throat-clearing or filler, concise phrasing. It applies to two things: published documentation (all of /docs), and comments or messages Claude posts to people through a connector (GitHub, Jira, Asana, Slack). Repo infrastructure (.github/, AGENTS.md, .claude/, source code, commit messages) stays out of scope.

  • docs/contributing/style-guide.md: new Concise, human phrasing subsection under Voice and tone, and a Dashes subsection under Punctuation that bans the em dash while keeping the en dash for numeric and date ranges.
  • .claude/skills/sumo-style/SKILL.md: mirrors the concision rule in Gotchas (the em dash ban was already there).
  • AGENTS.md: new Output tone section, so the rules also govern connector comments, where the sumo-style skill does not load.

A follow-up option, not in this PR: a PreToolUse hook could hard-enforce the em dash ban on Edit and Write to docs/** and on comment-posting commands. Verbosity stays a soft rule.

Select the type of change

  • Minor Changes - Typos, formatting, slight revisions
  • Update Content - Revisions, updating sections
  • New Content - New features, sections, pages, tutorials
  • Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

https://sumologic.atlassian.net/browse/DOCS-1868

🤖 Generated with Claude Code

Add a "no em dashes, be concise, plain language" standard that applies to published documentation and to comments Claude posts to people (GitHub, Jira, Asana, Slack). Repo infrastructure stays out of scope.

- docs/contributing/style-guide.md: new "Concise, human phrasing" and "Dashes" subsections.
- .claude/skills/sumo-style/SKILL.md: mirror the concision rule.
- AGENTS.md: new "Output tone" section so the rules reach connector comments, where the sumo-style skill does not load.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@kimsauce kimsauce self-assigned this Sep 3, 2026
@cla-bot cla-bot Bot added the cla-signed Contributor approved, listed in .clabot file label Sep 3, 2026
@kimsauce

kimsauce commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator Author

Superseded by #7101, which carries the same changes on a branch named for the correct ticket (DOCS-988, not DOCS-1868).

— via Claude Code

@kimsauce kimsauce closed this Sep 3, 2026
@kimsauce
kimsauce deleted the DOCS-1868 branch September 3, 2026 11:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed Contributor approved, listed in .clabot file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant