new-readme-maintenance
Installation
SKILL.md
Feature Documentation & README Maintenance Skill
This skill enforces the rule that every feature module in the codebase MUST have a clear, comprehensive, and up-to-date README.md file located at its root directory (e.g., src/features/<feature-name>/README.md).
Core Rules
- Mandatory Creation: When developing a new feature, a
README.mdfile MUST be created at the root of that feature folder. - Proactive Updates: Every time a feature is modified, refactored, or expanded (e.g., database schema changes, new services, new UI components, new actions, or new tests), the feature's
README.mdMUST be updated immediately in the same turn/commit. - Language Conventions:
- Technical explanations, architecture diagrams, and commands should be in English.
- Summaries, user-facing guides, and general explanations should be in Thai to align with the project's localization standard.
README Structure Template
Every feature README.md should follow this structure, adjusting sections as necessary:
# [Feature Name in Thai] ([Feature Name in English])