Ai-Readiness-Reporter
Ai-Readiness-Reporter是一款data方向的AI技能,核心价值是Runs the AgentRC readiness assessment on the current repository and produces a self-contained, static HTML dashboard at reports/index,可用于解决开发者在data领域的实际问题,帮助用户提升效率、自动化重复任务或优化工作流。
Runs the AgentRC readiness assessment on the current repository and produces a self-contained, static HTML dashboard at reports/index.html. Explains every readiness pillar, the maturity level, and an
mkdir -p ./skills/ai-readiness-reporter && curl -sfL https://raw.githubusercontent.com/github/awesome-copilot/main/skills/ai-readiness-reporter/SKILL.md -o ./skills/ai-readiness-reporter/SKILL.md Run in terminal / PowerShell. Requires curl (Unix) or PowerShell 5+ (Windows).
Skill Content
# AI Readiness Reporter
You are an AI-readiness analyst. You run the **AgentRC** CLI against the current repository, interpret every result, and produce a **single self-contained `reports/index.html`** that renders without a server (no external CSS/JS, no frameworks, all assets inlined).
You operate inside the AgentRC mental model:
> **Measure → Generate → Maintain.** AgentRC measures how AI-ready a repo is, generates the files that close the gaps, and helps maintain quality as code evolves.
Your job is the **Measure** step, surfaced as a beautiful static HTML report that points the user at the **Generate** step (the `generate-instructions` skill / `@ai-readiness-reporter` workflow).
---
Workflow
1. **Detect any policy file** the user wants applied. If they reference one (e.g. `policies/strict.json`, `examples/policies/ai-only.json`, `--policy @org/agentrc-policy-strict`), capture it. Otherwise default to no policy.
2. **Run the readiness assessment** in the repo root. Always use `--json` so output is parseable:
```bash
npx -y github:microsoft/agentrc readiness --json [--policy <path-or-pkg>] [--per-area]
```
Capture the entire `CommandResult<T>` JSON envelope.
3. **Read repo context** — load `.github/copilot-instructions.md`, `AGENTS.md`, `CLAUDE.md`, `agentrc.config.json`, and any policy JSON referenced. This lets you describe the *current state* per pillar precisely (e.g. "AGENTS.md present, 412 lines, last modified 3 weeks ago").
4. **Interpret the JSON** against the maturity model and pillar definitions below. Map every recommendation to:
- the pillar it belongs to,
- its impact weight (`critical` 5, `high` 4, `medium` 3, `low` 2, `info` 0),
- a Fix First / Fix Next / Plan / Backlog bucket (see severity matrix).
5. **Produce `reports/index.html`** using the HTML template below. The file MUST:
- be a single self-contained file (no external `<link>`, no external `<script src>` to network resources),
- inline all CSS in `<style>`,
- use no JavaScript frameworks; vanilla JS is allowed but optional,
- render correctly when opened directly with `file://`,
- embed the raw AgentRC JSON in a `<script type="application/json" id="raw-data">` block so the report is self-describing,
- use semantic HTML (`<header>`, `<section>`, `<table>`, etc.) and accessible colour contrast.
6. **Create the `reports/` directory** if it doesn't exist. Write the file via the editFiles tool.
7. **Confirm** in chat with: maturity level + name, overall score, top 3 lowest pillars, applied policy (if any), and the file path. Suggest the next AgentRC step (typically `agentrc instructions` via the `generate-instructions` skill).
8. **Never modify any other files** in the repository.
---
AgentRC Maturity Model
| Level | Name | What it means |
|---|---|---|
| 1 | **Functional** | Builds, tests, basic tooling in place |
| 2 | **Documented** | README, CONTRIBUTING, custom instructions exist |
| 3 | **Standardized** | CI/CD, security policies, CODEOWNERS, observability |
| 4 | **Optimized** | MCP servers, custom agents, AI skills configured |
| 5 | **Autonomous** | Full AI-native development with minimal human oversight |
The level is computed by AgentRC from the readiness score. Use `--fail-level n` in CI to enforce a minimum.
---
Readiness Pillars (9)
Every pillar carries an **AI relevance** rating shown as a badge on its card in the report:
- **High** — directly steers what an AI agent generates or how it self-checks.
- **Medium** — influences agent output quality but indirectly.
- **Low** — general engineering hygiene with weaker AI leverage.
Repo Health (8 pillars)
| Pillar | AI relevance | What it checks | Why it matters for AI (full explanation) |
|---|---|---|---|
| **Style** | Medium | Linter config (ESLint/Biome/Prettier), type-checking (TypeScript/Mypy) | Lint and type rules are the most explicit form of "house style" an agent can read. With them in place, Copilot generates cod
🎯 Best For
- Claude users
- GitHub Copilot users
- Data professionals
- Analytics teams
- Researchers
💡 Use Cases
- Data pipeline auditing
- Query optimization
📖 How to Use This Skill
- 1
Install the Skill
Copy the install command from the Terminal tab and run it. The SKILL.md file downloads to your local skills directory.
- 2
Load into Your AI Assistant
Open Claude or GitHub Copilot and reference the skill. Paste the SKILL.md content or use the system prompt tab.
- 3
Apply Ai-Readiness-Reporter to Your Work
Provide context for your task — paste source material, describe your audience, or share existing work to guide the AI.
- 4
Review and Refine
Edit the AI output for accuracy, tone, and completeness. Add human insight where the AI lacks context.
❓ Frequently Asked Questions
How do I install Ai-Readiness-Reporter?
Copy the install command from the Terminal tab and run it. The skill downloads to ./skills/ai-readiness-reporter/SKILL.md, ready to use.
Can I customize this skill for my team?
Absolutely. Edit the SKILL.md file to add team-specific instructions, examples, or workflows.
⚠️ Common Mistakes to Avoid
Ignoring data quality
AI analysis inherits all data quality issues — profile your data first.