⚡AgentSkills
✍️ Technical Writing · Dev Content & Advocacy

Write changelogs users read

User-outcome phrasing, migration notes, and consistent categories building release trust.

foundation~20 minTechnical WritersDeveloper AdvocatesEngineers Who Document

Steps

  1. 1Categorize: Added / Changed / Fixed / Breaking / Security only
  2. 2Phrase entries as user outcomes, not commit messages
  3. 3Breaking changes lead with migration snippet and deadline
  4. 4Link each entry to PR/docs for depth-seekers
  5. 5Keep voice consistent; assign one editor per release
  6. 6Never ship silent dependency bumps past Security category

Common Pitfalls

  • ▲'Misc fixes and improvements' filler sections
  • ▲Breaking changes discovered at runtime

Commands

Install with skills CLI
$ npx skills add aniruddhaadak80/skills --skill dev-content-changelog-users-read
Install globally
$ npx skills add aniruddhaadak80/skills --skill dev-content-changelog-users-read -g

Tags

#changelog#release-notes#technical-writing#dev-content

Related skills

Turn a debugging war story into a postfoundation

Structure bug-hunt experiences into engaging technical posts that teach method, not just drama. Use when writing dev blogs, hackathon retrospectives, or 'how I

✍️ Technical Writing·~40m
Open →