Skip to content

chore: add technical docs guidance to human-writing - #1645

Open
cmpadden wants to merge 1 commit into
mainfrom
add-writing-guidelines-skill
Open

chore: add technical docs guidance to human-writing#1645
cmpadden wants to merge 1 commit into
mainfrom
add-writing-guidelines-skill

Conversation

@cmpadden

@cmpadden cmpadden commented Aug 4, 2026

Copy link
Copy Markdown
Collaborator

Summary

Follow-up to #1644. Extend the existing human-writing skill with guidance for eve's technical documentation.

The landed skill's general editing, drafting, detection, voice-preservation, and AI-pattern guidance remains intact. This adds a technical documentation mode covering audience and page goals, neutral instructional voice, verified behavior, consistent terminology, page structure, links, placeholders, and TypeScript examples. The existing evaluation checklist gains focused checks for those rules.

The skill remains self-contained and continues to support its original non-documentation use cases. This is agent tooling only and does not change the published eve package, documentation, or runtime behavior.

Validation

  • git diff --check origin/main...HEAD
  • Pre-commit formatter passed for the skill files

Tests and a changeset are not applicable to this Markdown-only agent-tooling change.

Checklist

  • I linked an issue with prior discussion confirming this change is wanted
  • I ran the relevant checks from CONTRIBUTING.md
  • I added tests and documentation where relevant
  • I added a changeset if this touches the published eve package
  • DCO sign-off passes for every commit (git commit --signoff)

@cmpadden cmpadden mentioned this pull request Aug 4, 2026
5 tasks
@vercel

vercel Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
eve-docs Ready Ready Preview Aug 4, 2026 10:33pm
eve-docs-4759 Ready Ready Preview, v0 Aug 4, 2026 10:33pm

Comment thread .agents/skills/writing-guidelines/SKILL.md Outdated
@cmpadden
cmpadden force-pushed the add-writing-guidelines-skill branch from fd8080a to ea7b3af Compare August 4, 2026 22:07
@cmpadden
cmpadden force-pushed the add-writing-guidelines-skill branch from ea7b3af to 8e9dfa5 Compare August 4, 2026 22:18
@cmpadden cmpadden changed the title chore: add writing guidelines skill chore: tailor writing skill to technical docs Aug 4, 2026
@cmpadden
cmpadden force-pushed the add-writing-guidelines-skill branch from 8e9dfa5 to e3b4a9e Compare August 4, 2026 22:19
@vercel
vercel Bot temporarily deployed to Preview – eve-docs-4759 August 4, 2026 22:19 Inactive
@cmpadden
cmpadden force-pushed the add-writing-guidelines-skill branch from e3b4a9e to 1f13a06 Compare August 4, 2026 22:22
@cmpadden cmpadden changed the title chore: tailor writing skill to technical docs chore: refine human-writing skill for technical docs Aug 4, 2026
Signed-off-by: Colton Padden <colton.padden@vercel.com>
@cmpadden
cmpadden force-pushed the add-writing-guidelines-skill branch from 1f13a06 to 9c6a457 Compare August 4, 2026 22:31
@cmpadden cmpadden changed the title chore: refine human-writing skill for technical docs chore: add technical docs guidance to human-writing Aug 4, 2026
@cmpadden
cmpadden requested a review from AndrewBarba August 4, 2026 22:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants