creating-documentation

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.

跳到安装查看文件

仓库: willvelida/code-minions
最近来源活动: 2026年2月12日 08:24
检测到的 SKILL.md 语言: 英语
星标: 23
分支: 3

安装方式

默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。

用 AI 助手安装

复制这段 Prompt，发给你正在使用的 AI 助手。

Follow https://skillsmp.com/skill-install/prompt.md to install only the Agent Skill at https://github.com/willvelida/code-minions/tree/main/packages/creating-documentation/skills/creating-documentation.

直接命令不会经过审查 Prompt；运行前请先检查来源。

npx skills add https://github.com/willvelida/code-minions --skill creating-documentation

命令会保持在同一行。复制前请横向滚动并检查完整内容。

想先保存到本地？可下载 SkillsMP 当前能够提供的文件。

检查来源文件

决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。

文件资源管理器

9 个文件

SKILL.md

来源说明 · 只读预览

name: creating-documentation
description: 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.
license: MIT
allowed-tools: Bash

# Creating Documentation ## Overview 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. ## Capabilities | 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 | ## Standards 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 | ## Principles ### 1. Audience First 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. ### 2. Progressive Disclosure Present information in order of importance: - **Title & Description**: What is this project? (immediate) - **Installation & Usage**: How do I use it? (primary) - **Contributing & License**: How can I help? (secondary) ### 3. Accessibility Matters Documentation should be accessible to all users: - Use proper heading hierarchy (don't skip levels) - Provide alt text for all images - Write descriptive link text (not "click here") - Use plain language and short sentences ### 4. Keep It Current Outdated documentation is worse than no documentation. Include only information that can be maintained. Use automation where possible. ## Usage 1. Load this skill manifest 2. Identify the required capability (create or review) 3. Load the bundled standards from `standards/` 4. Execute the action following `actions/<capability>.md` ## References - [Make a README](https://www.makeareadme.com/) - [GitHub - About READMEs](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes) - [5 Tips for Making Your GitHub Profile Page Accessible](https://github.blog/developer-skills/github/5-tips-for-making-your-github-profile-page-accessible/) - [Choose a License](https://choosealicense.com/) - [Keep a Changelog](https://keepachangelog.com/)

在 GitHub 查看

返回搜索返回安装

creating-devcontainers

Create and review DevContainer configurations that follow organisational standards. Use when a user asks to set up a dev container, configure a development environment, create a devcontainer.json, add lifecycle hooks, review an existing DevContainer for compliance, or improve container security. Covers base images, features, extensions, lifecycle hooks, and security hardening.

2026-02-13

creating-agent-skill

Create and review Agent Skills that follow the open Agent Skills specification and best practices. Use when a user asks to create a new skill, build skill instructions, generate a SKILL.md file, review an existing skill for compliance, or improve skill quality. Covers skill structure, naming conventions, progressive disclosure, writing effective descriptions, creating actions and standards, and validation.

2026-02-12

creating-agents

Create and review agent definition files (agents.md) that give AI coding agents a clear persona, project knowledge, executable commands, code style examples, and explicit boundaries. Use when a user asks to create an agent, define an agent persona, write an agents.md file, set up a custom Copilot agent, review an existing agent definition, or improve agent quality. Covers the six core areas: commands, testing, project structure, code style, git workflow, and boundaries.

2026-02-12

查看这个仓库的全部 Skills

creating-documentation

来源信息

安装方式

用 AI 助手安装

检查来源文件

同仓库更多 Skills

用 AI 助手安装

同仓库更多 Skills