-
Notifications
You must be signed in to change notification settings - Fork 382
Create authoring-skills skill
#9716
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # Skill Authoring Checklist | ||
|
|
||
| Copy this checklist into your response when starting the creation of a new skill. | ||
|
|
||
| ```markdown | ||
| Skill Development Progress: | ||
| - [ ] Define Purpose: Confirm the skill is necessary and distinct from existing ones. | ||
kenzieschmoll marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - [ ] Naming: Select a lowercase, kebab-case name (prefer gerund form, e.g., adding-release-notes). | ||
| - [ ] Description: Write a third-person "what + when" description for the YAML frontmatter. | ||
| - [ ] Planning: Outline the `SKILL.md` sections (Workflow, Guidelines, Resources). | ||
| - [ ] Progressive Disclosure: Identify if any content should be moved to secondary files (EXAMPLES.md, REFERENCE.md). | ||
kenzieschmoll marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - [ ] Automation (Dart): Ensure any utility scripts in `scripts/` are written in **Dart**. | ||
| - [ ] Final Review: Ensure instructions are concise and skip "obvious" explanations. | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # Skill Authoring Examples | ||
|
|
||
| ## 1. Effective YAML Frontmatter | ||
|
|
||
| **Good (Gerund + What/When Description):** | ||
| ```yaml | ||
| --- | ||
| name: processing-logs | ||
| description: Extracts and summarizes error patterns from system logs. Use when the user asks to analyze logs or troubleshoot runtime errors. | ||
| --- | ||
| ``` | ||
|
|
||
| **Bad (Vague + First Person):** | ||
| ```yaml | ||
| --- | ||
| name: helper-tool | ||
| description: I can help you look at files and tell you what is wrong. | ||
| --- | ||
| ``` | ||
|
|
||
| ## 2. Progressive Disclosure Pattern | ||
|
|
||
| If a skill has a complex API or many configuration options, do not put them all in `SKILL.md`. | ||
|
|
||
| **SKILL.md:** | ||
| ```markdown | ||
| ## Advanced Configuration | ||
| For detailed information on environment variables and performance tuning, see [CONFIG.md](CONFIG.md). | ||
| ``` | ||
|
|
||
| ## 3. Workflow Patterns | ||
|
|
||
| Always use checklists to track state. | ||
|
|
||
| ```markdown | ||
| ## Workflow | ||
| Copy this checklist: | ||
| - [ ] Step 1: Analyze input. | ||
| - [ ] Step 2: Generate draft. | ||
| - [ ] Step 3: Run validation script. | ||
| ``` | ||
|
|
||
| ## 4. Automation with Dart | ||
|
|
||
| All scripts should be written in Dart and placed in the `scripts/` directory. | ||
|
|
||
| **Good Script Usage:** | ||
| ```markdown | ||
| ## Step 4: Add the entry | ||
| Use the provided utility script to insert the note safely. | ||
| `dart .agents/skills/adding-release-notes/scripts/add_note.dart "Inspector updates" "Added XYZ" TODO` | ||
| ``` | ||
|
|
||
| ## 5. Anti-Patterns to Avoid | ||
|
|
||
| - **Prohibited**: Using non-Dart languages for utility scripts. | ||
| - **Prohibited**: Using Windows-style paths (always use `/`). | ||
| - **Prohibited**: Offering too many options (narrow the scope to recommended defaults). | ||
| - **Prohibited**: Verbose background stories (Claude already knows how to code). | ||
| - **Prohibited**: Interactive prompts (Agents should be autonomous, not ask for permission at every step). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| --- | ||
| name: authoring-skills | ||
| description: Guides the creation of high-quality, effective skills for agentic workflows. Use when creating or modifying skills in the .agents/skills/ directory. | ||
| --- | ||
|
|
||
| # Authoring Skills | ||
|
|
||
| When creating or modifying skills in this repository, follow these best practices: | ||
|
|
||
| - **Antigravity Guidelines**: [Skill authoring best practices](https://antigravity.google/docs/skills) | ||
| - **Anthropic Guidelines**: [Skill authoring best practices](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/best-practices) | ||
|
|
||
| ## Repository-Specific Guidelines | ||
|
|
||
| - **Location**: All skills must be placed in the `.agents/skills/` directory. | ||
| - **Avoid Duplication**: Before creating a skill, check if one already exists in the [flutter/skills](https://github.com/flutter/skills/tree/main/skills) repository. If it does, do not create a local skill; instead, instruct the user to install it via `npx`. | ||
| - **Naming**: Use the gerund form (**verb-ing-noun**) or **noun-phrase** (e.g., `authoring-skills`, `adding-release-notes`). Use only lowercase letters, numbers, and hyphens. | ||
| - **Conciseness**: Prioritize brevity in `SKILL.md`. Agents are already highly capable; only provide context they don't already have. | ||
| - **Automation**: Any utility scripts placed in the `scripts/` directory MUST be written in **Dart**. | ||
| - **Progressive Disclosure**: Use the patterns below to organize instructions effectively: | ||
| - [CHECKLIST.md](CHECKLIST.md): Template for tracking skill development progress. | ||
| - [EXAMPLES.md](EXAMPLES.md): Local examples and anti-patterns. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.