Skip to content

docs(style): add plain-English guidelines #282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bougyman merged 1 commit into from
Sep 24, 2026
Merged

docs(style): add plain-English guidelines #282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .agents/skills
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../.ai/skills
1 change: 1 addition & 0 deletions .ai/skills/plain-english
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../../vendor/claude-plain-english-skill/skills/plain-english
1 change: 1 addition & 0 deletions .ai/skills/simple-english
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../../vendor/claude-plain-english-skill/skills/simple-english
3 changes: 3 additions & 0 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,6 @@
[submodule "vendor/stokowski"]
path = vendor/stokowski
url = git@github.com:bougyman/stokowski
[submodule "vendor/claude-plain-english-skill"]
path = vendor/claude-plain-english-skill
url = git@github.com:b1rdmania/claude-plain-english-skill
Comment thread
bougyman marked this conversation as resolved.
10 changes: 10 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@
This document provides an index and source reference of guidelines, processes,
and best practices for agents to follow.

## Documents

Use the [`simple-english`](vendor/claude-plain-english-skill/skills/simple-english) skill when
authoring technical documentation or instructions.

Use the [`plain-english`](vendor/claude-plain-english-skill/skills/plain-english) skill when
authoring non-technical documentation, marketing copy, or other content intended for a general audience.

Do not apply both to the same text.

## The Plan

- Initial Plan: documents/initial-plan.adoc (historical snapshot - not
Expand Down
1 change: 1 addition & 0 deletions vendor/claude-plain-english-skill
Open in desktop
Submodule claude-plain-english-skill added at 1e1501
Loading