chore(skills): improve write-docs principles and consolidate content type taxonomy#1758
Conversation
…type taxonomy Add four new documentation principles (For the right audience, Consistency, Accuracy over speed, Keep docs current) and reorder all principles by importance and semantic adjacency. Consolidate three redundant representations of the content type taxonomy (decision tree, pattern/focus table, and "By content type" heading) into a single unified table in Step 1. Co-authored-by: Cursor <cursoragent@cursor.com>
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Claude finished @nick-inkeep's task in 2m 41s —— View job PR Review Summary2 Key Findings | Risk: Low This is a well-structured improvement to the 🟡 Minor (2)🟡 1) Issue: Line 57 contains a typo in the word "analogous". Why: Minor quality issue that could distract readers and doesn't reflect the "Accuracy" principle the skill itself now espouses. Fix: - Don't bundle unrelated surfaces into one page unless a natural fit with the existing document or similar analagous docs.
+ Don't bundle unrelated surfaces into one page unless a natural fit with the existing document or similar analogous docs.🟡 2) Issue: The same line has "unless a natural fit" which is missing a verb. Why: Slightly awkward phrasing that could be clearer. Fix: - Don't bundle unrelated surfaces into one page unless a natural fit with the existing document or similar analagous docs.
+ Don't bundle unrelated surfaces into one page unless it's a natural fit with the existing document or similar analogous docs.✅ Verified Positive Changes
✅ APPROVESummary: This is a clean, well-thought-out improvement to the write-docs skill. The structural changes (moving Philosophy before Workflow, consolidating the content type table) improve readability. The new principles add valuable guidance. Two minor typos/grammar issues noted above can be fixed in a follow-up or this PR. No blocking concerns. Other Findings (0)No other findings. All changes reviewed and validated. |
Fix "analagous" → "analogous" and add missing verb "it's" for subject-verb agreement. Co-authored-by: Cursor <cursoragent@cursor.com>
|
Claude finished @nick-inkeep's task in 1m 32s —— View job PR Review Summary1 Key Finding | Risk: Low This is a well-structured improvement to the 🟡 Minor (1)🟡 1) Issue: Line 57 contains "as a appropriate" which should be "as appropriate" (extra article "a"). Why: Minor grammar issue that slightly detracts from the document quality. Fix: - - **Right detail, right place**: Avoid duplication. If something is explained elsewhere, link to it or reuse it in some way as a appropriate.
+ - **Right detail, right place**: Avoid duplication. If something is explained elsewhere, link to it or reuse it in some way as appropriate.✅ Verified Positive Changes
✅ APPROVE WITH SUGGESTIONSSummary: This is a clean, well-thought-out improvement to the write-docs skill. The previous review findings were addressed in the latest commit. One remaining minor grammar issue noted above ("as a appropriate" → "as appropriate") can be fixed in a follow-up or this PR. No blocking concerns. Other Findings (1)Potentially valid
|
Co-authored-by: Cursor <cursoragent@cursor.com>
|
Claude finished @nick-inkeep's task in 2m 4s —— View job PR Review Summary0 Key Findings | Risk: Low This is a well-structured improvement to the ✅ Verified Positive Changes
✅ APPROVESummary: This is a clean, well-thought-out improvement to the write-docs skill. All previous review findings have been addressed. The structural changes improve readability, and the new principles add valuable guidance for AI agents writing documentation. No blocking concerns. 🎉 Other Findings (1)Potentially valid
|
1 participant
Summary
Improves the
write-docsAI agent skill with stronger documentation principles and cleaner structure.Principles
Added 4 new principles:
Reordered all 11 principles by importance and semantic adjacency:
Content type consolidation
Other minor changes
Test plan
.cursor/,.codex/,.claude/are regenerated correctly by toolingMade with Cursor