docs: adopt the two-layer writing standard - #45
Merged
Conversation
Align this repo with the updated setup-guplem-standard skill. The "Communicating with users" section becomes "Writing style" and states two layers: Zinsser's four principles for all prose, and ASD-STE100 on top for technical documents. The skills that referenced the old heading now name the new section. Their partial copies of the rules are gone, because AGENTS.md is the one home for them. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
guplem
added
the
waiting-for-human-check
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
1 participant
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.
TL;DR: this repo's writing rules now match the updated
setup-guplem-standardskill. Documentation only, no behavior change.What changed
AGENTS.md: the "Communicating with users" section became "Writing style" and now states two layers.AGENTS.md, ADRs,README.md, skills, subagents, code comments): ASD-STE100, Simplified Technical English. Active voice, one meaning per word, verb-first instructions, no-ingform as a noun, about 20 words per sentence.The replacement also restores a Layer 1 bullet this file was missing: "Assume junior-level knowledge of the area."
The skills
write-ai-instructions,write-commit,review-pr,implement-issue, andcreate-issueeach named the old heading. Each now names "Writing style". Their partial copies of the rules are gone, becauseAGENTS.mdis the one home for them.Checks
dart formatcovers*.dartfiles only, so no markdown needed reformatting. Theanalyze-and-testjob is untouched.