readme-polish
Improve a README for clarity and completeness. Use when a junior developer needs guidance on documenting setup and usage.
Informações da origem
- Repositório
- proflead/codex-skills-library
- Última atividade na origem
- 12 de janeiro de 2026 às 16:12
- Idioma detectado do SKILL.md
- inglês
- Estrelas
- 154
- Forks
- 34
Opções de instalação
Por padrão, está selecionado o prompt que primeiro revisa a origem. Você pode mudar para um comando direto ou baixar uma cópia local.
Revise os arquivos de origem
Leia o SKILL.md e os arquivos complementares exibidos pelo SkillsMP antes de decidir se vai instalar.
Exibindo SKILL.md
SKILL.md
Instruções da origem · Visualização somente leitura- 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.
Ver no GitHub