snowspeeder/pi-web
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(agents): add positive-phrasing principle to documentation guide

Browse Source 
Record that docs state what the software does and reserve "does not"
statements for behavior that contradicts the most obvious expectation.
This commit is contained in:
Federico Jaramillo Martinez
2026-07-28 19:43:32 +02:00
parent 5b717ed542
commit 612ea74720
1 changed files with 1 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.agents/skills/documentation-guide/SKILL.md
+1
View File
@@ -81,6 +81,7 @@ If the content needs multiple sentences of caveats, explains how an internal mec
## Writing principles
- Lead with the user outcome, then the command or action needed.
- State what the software does rather than listing what it does not do; reserve "does not" statements for the rare case where behavior genuinely contradicts the most obvious expectation.
- Prefer concrete guidance over internal type, module, or orchestration terminology.
- Explain implementation details only when they help users make a decision or recover from a failure.
- Distinguish supported behavior from recommendations and prospective behavior.