readme-polish
Improve a README for clarity and completeness. Use when a junior developer needs guidance on documenting setup and usage.
소스 정보
- 저장소
- proflead/codex-skills-library
- 최근 소스 활동
- 2026년 1월 12일 16:12
- 감지된 SKILL.md 언어
- 영어
- 스타
- 154
- 포크
- 34
설치 방법
기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.
소스 파일 검토
설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.
SKILL.md 표시 중
SKILL.md
소스 지침 · 읽기 전용 미리보기- name
- readme-polish
- description
- Improve a README for clarity and completeness. Use when a junior developer needs guidance on documenting setup and usage.
# README Polish
## Purpose
Improve a README for clarity and completeness.
## Inputs to request
- Current README content.
- Setup prerequisites and runtime versions.
- Common failure modes or FAQs.
## Workflow
1. Ensure install, run, and test steps are present and ordered.
2. Add required environment variables and configuration notes.
3. Clarify expected outputs and common troubleshooting tips.
## Output
- Revised README section suggestions.
- Checklist of missing items.
## Quality bar
- Keep instructions concise and copy-pasteable.
- Surface the most common pitfalls early.
GitHub에서 보기