Create and review README files and repository documentation that follows best practices for clarity, accessibility, and discoverability. Use when a user asks to create a README, write project documentation, improve existing documentation, add a CONTRIBUTING guide, review documentation for accessibility, or document a new repository.
This skill provides capabilities for creating and reviewing README files and other repository documentation that follows established best practices for structure, accessibility, and user experience.
Good documentation is the front door to your project. It helps users understand what your project does, how to use it, and how to contribute. This skill ensures documentation is clear, accessible, and follows industry standards.
| Capability | Action | Description |
|------------|--------|-------------|
| Create README | actions/create-readme.md | Generate a comprehensive README for a repository |
| Create CONTRIBUTING | actions/create-contributing.md | Generate contribution guidelines |
| Review | actions/review-documentation.md | Analyse existing documentation for quality and accessibility |
This skill bundles the following standards in standards/:
| Standard | File | Description |
|----------|------|-------------|
| README Structure | readme-structure.md | Essential sections and organization for README files |
| Accessibility | accessibility.md | Accessibility requirements for inclusive documentation |
| Writing Style | writing-style.md | Plain language and readability guidelines |
| Markdown | markdown.md | Markdown formatting best practices |
| Checklist | checklist.md | Consolidated compliance and quality checklist |
Write for your audience. A README's primary purpose is to help visitors quickly understand your project and get started. Don't assume prior knowledge—provide context and links for unfamiliar concepts.
Present information in order of importance:
Documentation should be accessible to all users:
Outdated documentation is worse than no documentation. Include only information that can be maintained. Use automation where possible.
standards/actions/<capability>.mdnpx skills add willvelida/creating-documentation下载完整 Skill 目录，包含 SKILL.md 及所有相关文件
Search for places (restaurants, cafes, etc.) via Google Places API proxy on localhost.
Interact with GitHub using the `gh` CLI. Use `gh issue`, `gh pr`, `gh run`, and `gh api` for issues, PRs, CI runs, and advanced queries.
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Start voice calls via the OpenClaw voice-call plugin.
Notion API for creating and managing pages, databases, and blocks.
Gemini CLI for one-shot Q&A, summaries, and generation.
Category:developer