Writing Evergreen Comments
CommunityComments that last: explain WHY, not WHAT.
Software Engineering#code quality#refactoring#technical writing#maintainability#developer experience#comments#code documentation
Authorbarrydobson
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill eliminates stale, misleading, or redundant comments that clutter code and confuse future maintainers. It ensures comments provide lasting value by focusing on intent and non-obvious decisions, rather than temporary context or code mechanics.
Core Features & Use Cases
- Focus on WHY: Guides you to explain the rationale behind code, complex logic, or non-obvious decisions, providing crucial context for future changes.
- Avoid Temporal Context: Prevents comments from documenting change history ("refactored from X") or temporary states, which quickly become outdated.
- ABOUTME File Headers: Enforces a consistent, greppable two-line header for every file to quickly understand its purpose and key details.
- Use Case: When refactoring a legacy module, instead of commenting "// Refactored from old system", use this skill to write "// This module processes financial transactions according to GAAP principles" and add an ABOUTME header.
Quick Start
Review the attached code snippet. Rewrite its comments to be evergreen, focusing on WHY and removing any temporal or instructional context. Ensure file headers use the ABOUTME pattern.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: Writing Evergreen Comments Download link: https://github.com/barrydobson/dotfiles_extra/archive/main.zip#writing-evergreen-comments Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.