Improve writing style with rules in the doc-writer skill - #1793
Open
Alistair Matthews (alistairmatthews) wants to merge 2 commits into
Open
Alistair Matthews (alistairmatthews) wants to merge 2 commits into
Alistair Matthews (alistairmatthews) wants to merge 2 commits into
Conversation
Alistair Matthews (alistairmatthews)
marked this pull request as ready for review
September 29, 2026 15:51
Alistair Matthews (alistairmatthews)
requested a review
from David Pine (IEvangelist)
as a code owner
September 29, 2026 15:51
Copilot started reviewing on behalf of
Alistair Matthews (alistairmatthews)
September 29, 2026 15:52
View session
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The guidance consistently addresses issue #1792 and is correctly propagated to related documentation workflows.
Review effort: Balanced
Findings: None
What changed in this PR
Adds writing-style guidance to reduce recognizable AI prose patterns and improve documentation clarity, addressing issue #1792.
Changes:
- Adds a comprehensive “Prose patterns to avoid” checklist to the
doc-writerskill. - References the checklist from Astro and Community Toolkit writing instructions.
- Updates the “What’s new” critique/template guidance to avoid em dashes.
| File | Description |
|---|---|
.github/instructions/astro.instructions.md |
Requires documentation prose to follow the new checklist. |
.github/agents/community-toolkit-integration-doc-writer.agent.md |
Applies the checklist to integration documentation. |
.agents/skills/whatsnew/references/whats-new-template.mdx |
Replaces an em dash in the SEO title example. |
.agents/skills/whatsnew/references/03-critique.md |
Adds the checklist to release-note critique criteria. |
.agents/skills/doc-writer/SKILL.md |
Defines prose structures, wording, tone, and formatting to avoid. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
AI-written text in this repo is often identifiably so and this can reduce comprehensibility for our audience. This PR addresses #1792 and implements many of the tropes listed at tropes.fyi. I've left some of those tropes out because I judged them to be helpful in this documentation.
Third-party links and affiliations
None
Validation
I asked Copilot to write some new prose in an article, locally, and observed fewer of these issues.
Fixes: #1792