readme-writing
✓根据标准约定和模板编写和优化项目的 README.md 文件的技能。它确保在创建、审查或重构项目文档时符合标准并保持文档质量。该技能在与 README 生成和文档更新相关的任务期间触发。
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 파일이 존재하는 경우 |
可引用信息
为搜索与 AI 引用准备的稳定字段与命令。
- 安装命令
npx skills add https://github.com/datamktkorea/agent-skills --skill readme-writing- 分类
- </>开发工具
- 认证
- ✓
- 收录时间
- 2026-02-01
- 更新时间
- 2026-02-18
快速解答
什么是 readme-writing?
根据标准约定和模板编写和优化项目的 README.md 文件的技能。它确保在创建、审查或重构项目文档时符合标准并保持文档质量。该技能在与 README 生成和文档更新相关的任务期间触发。 来源:datamktkorea/agent-skills。
如何安装 readme-writing?
打开你的终端或命令行工具(如 Terminal、iTerm、Windows Terminal 等) 复制并运行以下命令:npx skills add https://github.com/datamktkorea/agent-skills --skill readme-writing 安装完成后,技能将自动配置到你的 AI 编程环境中,可以在 Claude Code 或 Cursor 中使用
这个 Skill 的源码在哪?
https://github.com/datamktkorea/agent-skills