readme-writing
✓A skill for writing and optimizing a project's README.md file in accordance with standard conventions and templates. It ensures compliance with standards and maintains documentation quality when creating, reviewing, or refactoring project documentation. This skill is triggered during tasks related to README generation and documentation updates.
Installation
SKILL.md
이 스킬은 프로젝트의 README.md 파일을 작성하거나 업데이트할 때 사용합니다. 아래의 작성 규칙과 템플릿을 엄격히 준수하십시오.
| Overview | ✅ | 항상 포함 | | Tech Stack | ✅ | 항상 포함 | | Architecture | ⚪ | 서비스 간 통신 또는 외부 의존성이 있는 경우 | | Directory Structure | ✅ | 항상 포함 | | Configuration | ⚪ | .env.example 또는 config/ 폴더가 존재하는 경우 | | Quick Start | ✅ | 항상 포함 | | Operations Guide | ⚪ | docker-compose.yml 또는 배포 스크립트가 존재하는 경우 | | Troubleshooting | ⚪ | 알려진 이슈가 있는 경우 |
| Contributing | ⚪ | 오픈소스 또는 CONTRIBUTING.md가 존재하는 경우 | | License | ⚪ | LICENSE 파일이 존재하는 경우 |
Facts (cite-ready)
Stable fields and commands for AI/search citations.
- Install command
npx skills add https://github.com/datamktkorea/agent-skills --skill readme-writing- Category
- </>Dev Tools
- Verified
- ✓
- First Seen
- 2026-02-01
- Updated
- 2026-02-18
Quick answers
What is readme-writing?
A skill for writing and optimizing a project's README.md file in accordance with standard conventions and templates. It ensures compliance with standards and maintains documentation quality when creating, reviewing, or refactoring project documentation. This skill is triggered during tasks related to README generation and documentation updates. Source: datamktkorea/agent-skills.
How do I install readme-writing?
Open your terminal or command line tool (Terminal, iTerm, Windows Terminal, etc.) Copy and run this command: npx skills add https://github.com/datamktkorea/agent-skills --skill readme-writing Once installed, the skill will be automatically configured in your AI coding environment and ready to use in Claude Code or Cursor
Where is the source repository?
https://github.com/datamktkorea/agent-skills