heraspec 0.1.14 → 0.1.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +187 -0
- package/README.md +94 -95
- package/bin/heraspec.js +195 -80
- package/bin/heraspec.js.map +2 -2
- package/dist/core/templates/skills/README.md +41 -38
- package/dist/core/templates/skills/campaign-plan/skill.md +76 -0
- package/dist/core/templates/skills/campaign-plan/skill.vi.md +76 -0
- package/dist/core/templates/skills/campaign-plan-skill.md +76 -0
- package/dist/core/templates/skills/campaign-plan-skill.vi.md +76 -0
- package/dist/core/templates/skills/code-review/skill.md +70 -0
- package/dist/core/templates/skills/code-review/skill.vi.md +70 -0
- package/dist/core/templates/skills/code-review-skill.md +70 -0
- package/dist/core/templates/skills/code-review-skill.vi.md +70 -0
- package/dist/core/templates/skills/content-creation/skill.md +69 -0
- package/dist/core/templates/skills/content-creation/skill.vi.md +69 -0
- package/dist/core/templates/skills/content-creation-skill.md +69 -0
- package/dist/core/templates/skills/content-creation-skill.vi.md +69 -0
- package/dist/core/templates/skills/content-optimization/skill.md +104 -0
- package/dist/core/templates/skills/debug/skill.md +69 -0
- package/dist/core/templates/skills/debug/skill.vi.md +69 -0
- package/dist/core/templates/skills/debug-skill.md +69 -0
- package/dist/core/templates/skills/debug-skill.vi.md +69 -0
- package/dist/core/templates/skills/deploy-documentation/skill.md +408 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/airbnb/DESIGN.md +246 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/airtable/DESIGN.md +89 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/apple/DESIGN.md +313 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/bmw/DESIGN.md +180 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/cal/DESIGN.md +259 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/claude/DESIGN.md +312 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/clay/DESIGN.md +304 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/clickhouse/DESIGN.md +281 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/cohere/DESIGN.md +266 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/coinbase/DESIGN.md +129 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/composio/DESIGN.md +307 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/cursor/DESIGN.md +309 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/elevenlabs/DESIGN.md +265 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/expo/DESIGN.md +281 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/figma/DESIGN.md +220 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/framer/DESIGN.md +246 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/hashicorp/DESIGN.md +278 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/ibm/DESIGN.md +332 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/index.json +72 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/intercom/DESIGN.md +146 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/kraken/DESIGN.md +125 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/linear.app/DESIGN.md +367 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/lovable/DESIGN.md +298 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/minimax/DESIGN.md +257 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/mintlify/DESIGN.md +326 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/miro/DESIGN.md +108 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/mistral.ai/DESIGN.md +261 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/mongodb/DESIGN.md +266 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/notion/DESIGN.md +309 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/nvidia/DESIGN.md +293 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/ollama/DESIGN.md +267 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/opencode.ai/DESIGN.md +281 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/pinterest/DESIGN.md +230 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/posthog/DESIGN.md +256 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/raycast/DESIGN.md +268 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/replicate/DESIGN.md +261 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/resend/DESIGN.md +303 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/revolut/DESIGN.md +185 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/runwayml/DESIGN.md +244 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/sanity/DESIGN.md +357 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/sentry/DESIGN.md +262 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/spacex/DESIGN.md +194 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/spotify/DESIGN.md +246 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/stripe/DESIGN.md +322 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/supabase/DESIGN.md +255 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/superhuman/DESIGN.md +252 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/together.ai/DESIGN.md +263 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/uber/DESIGN.md +295 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/vercel/DESIGN.md +310 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/voltagent/DESIGN.md +323 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/warp/DESIGN.md +253 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/webflow/DESIGN.md +92 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/wise/DESIGN.md +173 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/x.ai/DESIGN.md +257 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/zapier/DESIGN.md +328 -0
- package/dist/core/templates/skills/design-system/skill.md +176 -0
- package/dist/core/templates/skills/documents/skill.md +104 -0
- package/dist/core/templates/skills/e2e-test/skill.md +119 -0
- package/dist/core/templates/skills/email-sequence/skill.md +68 -0
- package/dist/core/templates/skills/email-sequence/skill.vi.md +68 -0
- package/dist/core/templates/skills/email-sequence-skill.md +68 -0
- package/dist/core/templates/skills/email-sequence-skill.vi.md +68 -0
- package/dist/core/templates/skills/git-embed/skill.md +57 -0
- package/dist/core/templates/skills/integration-test/skill.md +118 -0
- package/dist/core/templates/skills/knowledge/README.md +63 -63
- package/dist/core/templates/skills/knowledge/design-systems/index.json +72 -72
- package/dist/core/templates/skills/knowledge/frameworks/php/codeigniter/rise-cms/profile.json +27 -27
- package/dist/core/templates/skills/knowledge/frameworks/php/codeigniter/rise-cms/structure.md +137 -137
- package/dist/core/templates/skills/knowledge/frameworks/php/laravel/botble/profile.json +39 -39
- package/dist/core/templates/skills/knowledge/frameworks/php/laravel/botble/structure.md +207 -207
- package/dist/core/templates/skills/knowledge/frameworks/php/wordpress/core/profile.json +51 -51
- package/dist/core/templates/skills/knowledge/frameworks/php/wordpress/core/structure.md +369 -369
- package/dist/core/templates/skills/knowledge/index.json +65 -65
- package/dist/core/templates/skills/perfex-module/module-codebase/skill.md +110 -0
- package/dist/core/templates/skills/project-memory/skill.md +222 -0
- package/dist/core/templates/skills/project-memory/skill.vi.md +223 -0
- package/dist/core/templates/skills/seo-audit/skill.md +75 -0
- package/dist/core/templates/skills/seo-audit/skill.vi.md +75 -0
- package/dist/core/templates/skills/seo-audit-skill.md +75 -0
- package/dist/core/templates/skills/seo-audit-skill.vi.md +75 -0
- package/dist/core/templates/skills/smart-explore/skill.md +141 -0
- package/dist/core/templates/skills/sourcecode-analyzer/skill.md +210 -0
- package/dist/core/templates/skills/sourcecode-analyzer/skill.vi.md +210 -0
- package/dist/core/templates/skills/spec-writer/skill.md +61 -0
- package/dist/core/templates/skills/spec-writer/skill.vi.md +61 -0
- package/dist/core/templates/skills/spec-writer-skill.md +61 -0
- package/dist/core/templates/skills/spec-writer-skill.vi.md +61 -0
- package/dist/core/templates/skills/sql-queries/skill.md +67 -0
- package/dist/core/templates/skills/sql-queries/skill.vi.md +67 -0
- package/dist/core/templates/skills/sql-queries-skill.md +67 -0
- package/dist/core/templates/skills/sql-queries-skill.vi.md +67 -0
- package/dist/core/templates/skills/suggestion/skill.md +118 -0
- package/dist/core/templates/skills/system-design/skill.md +70 -0
- package/dist/core/templates/skills/system-design/skill.vi.md +70 -0
- package/dist/core/templates/skills/system-design-skill.md +70 -0
- package/dist/core/templates/skills/system-design-skill.vi.md +70 -0
- package/dist/core/templates/skills/tech-debt/skill.md +70 -0
- package/dist/core/templates/skills/tech-debt/skill.vi.md +70 -0
- package/dist/core/templates/skills/tech-debt-skill.md +70 -0
- package/dist/core/templates/skills/tech-debt-skill.vi.md +70 -0
- package/dist/core/templates/skills/ui-ux/data/charts.csv +26 -0
- package/dist/core/templates/skills/ui-ux/data/colors.csv +97 -0
- package/dist/core/templates/skills/ui-ux/data/design-systems.csv +54 -0
- package/dist/core/templates/skills/ui-ux/data/landing.csv +31 -0
- package/dist/core/templates/skills/ui-ux/data/pages-proposed.csv +22 -0
- package/dist/core/templates/skills/ui-ux/data/pages.csv +10 -0
- package/dist/core/templates/skills/ui-ux/data/products.csv +97 -0
- package/dist/core/templates/skills/ui-ux/data/prompts.csv +24 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/flutter.csv +53 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/html-tailwind.csv +56 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/nextjs.csv +53 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/react-native.csv +52 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/react.csv +54 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/svelte.csv +54 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/swiftui.csv +51 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/vue.csv +50 -0
- package/dist/core/templates/skills/ui-ux/data/styles.csv +59 -0
- package/dist/core/templates/skills/ui-ux/data/typography.csv +58 -0
- package/dist/core/templates/skills/ui-ux/data/ux-guidelines.csv +100 -0
- package/dist/core/templates/skills/ui-ux/scripts/CODE_EXPLANATION.md +394 -0
- package/dist/core/templates/skills/ui-ux/scripts/SEARCH_ALGORITHMS_COMPARISON.md +421 -0
- package/dist/core/templates/skills/ui-ux/scripts/SEARCH_MODES_GUIDE.md +238 -0
- package/dist/core/templates/skills/ui-ux/scripts/core.py +391 -0
- package/dist/core/templates/skills/ui-ux/scripts/search.py +73 -0
- package/dist/core/templates/skills/ui-ux/skill.md +595 -0
- package/dist/core/templates/skills/ui-ux/templates/accessibility-checklist.md +40 -0
- package/dist/core/templates/skills/ui-ux/templates/example-prompt-full-theme.md +333 -0
- package/dist/core/templates/skills/ui-ux/templates/page-types-guide.md +338 -0
- package/dist/core/templates/skills/ui-ux/templates/pages-proposed-summary.md +273 -0
- package/dist/core/templates/skills/ui-ux/templates/pre-delivery-checklist.md +42 -0
- package/dist/core/templates/skills/ui-ux/templates/prompt-template-full-theme.md +313 -0
- package/dist/core/templates/skills/ui-ux/templates/responsive-design.md +40 -0
- package/dist/core/templates/skills/unit-test/skill.md +111 -0
- package/dist/core/templates/skills/wordpress/plugin-check/skill.md +151 -0
- package/dist/core/templates/skills/wordpress/plugin-directory/skill.md +396 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/skill.md +100 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/admin-dashboard.php +47 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/admin-settings.php +60 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/assets/admin-css.css +22 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/assets/admin-js.js +15 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/plugin-main.php +169 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/readme.txt +41 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/uninstall.php +21 -0
- package/dist/core/templates/skills/wordpress/ux-element/skill.md +83 -0
- package/dist/core/templates/skills/wordpress/ux-element/templates/Controller.php +50 -0
- package/dist/core/templates/skills/wordpress/ux-element/templates/Shortcode.php +23 -0
- package/dist/core/templates/skills/wordpress/ux-element/templates/Template.html +20 -0
- package/dist/core/templates/skills/wordpress/ux-element/templates/Thumbnail.svg +8 -0
- package/dist/core/templates/skills/wordpress/ux-element/templates/View.php +21 -0
- package/dist/index.js +195 -79
- package/package.json +1 -1
|
@@ -1,38 +1,41 @@
|
|
|
1
|
-
# Skills Templates
|
|
2
|
-
|
|
3
|
-
This directory contains skill
|
|
4
|
-
|
|
5
|
-
##
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
1
|
+
# Skills Templates
|
|
2
|
+
|
|
3
|
+
This directory contains self-contained skill templates and resources for HeraSpec skills. Every skill is placed inside its own subdirectory to hold its `skill.md` and associated assets (templates, scripts, design knowledge, etc.).
|
|
4
|
+
|
|
5
|
+
## Directory Structure
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
skills/
|
|
9
|
+
├── <skill-name>/
|
|
10
|
+
│ ├── skill.md ← Skill guidelines (English)
|
|
11
|
+
│ ├── skill.vi.md ← Skill guidelines (Vietnamese, optional)
|
|
12
|
+
│ ├── templates/ ← Skill-specific templates (optional)
|
|
13
|
+
│ ├── scripts/ ← Skill-specific automation scripts (optional)
|
|
14
|
+
│ └── data/ ← Skill-specific databases/assets (optional)
|
|
15
|
+
└── knowledge/ ← HeRaSpec global knowledge base (pre-analyzed profiles)
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Available Skills
|
|
19
|
+
|
|
20
|
+
- **`ui-ux/`** - For UI/UX design and styling (includes search script, design databases, and prompt templates).
|
|
21
|
+
- **`design-system/`** - For designing according to specific popular design systems (references `knowledge/design-systems`).
|
|
22
|
+
- **`documents/`** - For technical and user documentation.
|
|
23
|
+
- **`content-optimization/`** - For content and CTA optimization.
|
|
24
|
+
- **`unit-test/`**, **`integration-test/`**, **`e2e-test/`** - Testing skills.
|
|
25
|
+
- **`sourcecode-analyzer/`** - Pre-analyzed codebase scanning.
|
|
26
|
+
- **`project-memory/`** - Memory-aware session summary and indexing.
|
|
27
|
+
- **`smart-explore/`** - Smart file/project exploration.
|
|
28
|
+
- **`deploy-documentation/`** - Automating deploy instructions.
|
|
29
|
+
- **`code-review/`**, **`debug/`**, **`system-design/`**, **`tech-debt/`**, **`spec-writer/`** - Standard coding lifecycle skills.
|
|
30
|
+
- **`seo-audit/`**, **`campaign-plan/`**, **`content-creation/`**, **`email-sequence/`**, **`sql-queries/`** - Marketing, SEO, and database planning skills.
|
|
31
|
+
- **`perfex-module/module-codebase/`** - Perfex CRM module codebase skill.
|
|
32
|
+
- **`wordpress/ux-element/`** - flatsome UX Builder element development.
|
|
33
|
+
- **`wordpress/plugin-standard/`** - WordPress plugin coding standards.
|
|
34
|
+
- **`wordpress/plugin-check/`** - WordPress Plugin Check tool running and fix guidelines.
|
|
35
|
+
- **`wordpress/plugin-directory/`** - WordPress.org Plugin Directory submission guideline checks.
|
|
36
|
+
|
|
37
|
+
## UI/UX & Design System Resources
|
|
38
|
+
|
|
39
|
+
- **`ui-ux/scripts/`**: `search.py` and `core.py` for searching the design databases.
|
|
40
|
+
- **`ui-ux/data/`**: CSV databases for Styles, Colors, Typography, Stacks, UX guidelines, etc.
|
|
41
|
+
- **`design-system/knowledge/design-systems/`**: Complete markdown design guidelines (`DESIGN.md`) for popular platforms like Stripe, Notion, Linear, Vercel, etc.
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Skill: Campaign Plan (Cross-Cutting)
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Generate a comprehensive marketing campaign brief covering goals, target audience, key messaging, week-by-week channel strategy, content calendar, and success metrics.
|
|
6
|
+
|
|
7
|
+
## When to Use
|
|
8
|
+
|
|
9
|
+
- When planning a new product launch, lead-generation push, or brand awareness campaign.
|
|
10
|
+
- When you need a week-by-week content calendar mapping dependencies between assets.
|
|
11
|
+
- When translating business and marketing goals into structured, executable campaign tasks.
|
|
12
|
+
|
|
13
|
+
## Step-by-Step Process
|
|
14
|
+
|
|
15
|
+
### Step 1: Objective & Audience Definition
|
|
16
|
+
- Formulate SMART objectives (e.g., generate 200 SQLs in 6 weeks).
|
|
17
|
+
- Define primary and secondary audience segments, their pain points, and stage in the buyer's journey.
|
|
18
|
+
|
|
19
|
+
### Step 2: Messaging & Differentiation
|
|
20
|
+
- Define one core campaign message and 3-4 supporting messages tailored to pain points.
|
|
21
|
+
- Identify solid proof points (case studies, data, testimonials) to support the messaging.
|
|
22
|
+
|
|
23
|
+
### Step 3: Channel Strategy
|
|
24
|
+
- Select channels based on audience habits:
|
|
25
|
+
- Owned (blog, email, social)
|
|
26
|
+
- Earned (PR, influencer, guest posts)
|
|
27
|
+
- Paid (SEM, social ads, sponsorships)
|
|
28
|
+
- Map effort levels (low, medium, high) and budget allocations.
|
|
29
|
+
|
|
30
|
+
### Step 4: Content Calendar & Asset Mapping
|
|
31
|
+
- Build a week-by-week content calendar in table format.
|
|
32
|
+
- List all required content assets with priority and creation deadlines.
|
|
33
|
+
|
|
34
|
+
### Step 5: Success Metrics & KPIs
|
|
35
|
+
- Define primary and secondary KPIs.
|
|
36
|
+
- Establish tracking mechanisms and risk mitigation plans.
|
|
37
|
+
|
|
38
|
+
## Required Input
|
|
39
|
+
|
|
40
|
+
- **Campaign Goal**: Drive signups, product launch, lead-gen, etc.
|
|
41
|
+
- **Target Audience**: Roles, industry, pain points.
|
|
42
|
+
- **Timeline**: Campaign duration and key launch dates.
|
|
43
|
+
- **Budget Tier** (Optional): Paid media budget range.
|
|
44
|
+
|
|
45
|
+
## Expected Output
|
|
46
|
+
|
|
47
|
+
- **Executive Summary**: One-sentence summary and main measurable target.
|
|
48
|
+
- **Audience Profile**: 2-3 sentence summary of the target buyers.
|
|
49
|
+
- **Messaging Matrix**: Key message, supporting points, and proof points.
|
|
50
|
+
- **Content Calendar Table**: Columns for Week, Asset Name, Channel, and Notes.
|
|
51
|
+
- **Success Metrics Table**: List of KPIs, target numbers, and tracking methods.
|
|
52
|
+
- **Next Steps Checklist**: Actionable kick-off tasks.
|
|
53
|
+
|
|
54
|
+
## Tone & Rules
|
|
55
|
+
|
|
56
|
+
- Write in a highly structured, strategic, and professional tone.
|
|
57
|
+
- Ensure all campaign goals follow the SMART framework.
|
|
58
|
+
- Always include clear dependencies in the content calendar.
|
|
59
|
+
|
|
60
|
+
## Available Templates
|
|
61
|
+
|
|
62
|
+
- None
|
|
63
|
+
|
|
64
|
+
## Available Scripts
|
|
65
|
+
|
|
66
|
+
- None
|
|
67
|
+
|
|
68
|
+
## Examples
|
|
69
|
+
|
|
70
|
+
See `examples/` directory.
|
|
71
|
+
|
|
72
|
+
## Links to Other Skills
|
|
73
|
+
|
|
74
|
+
- **documents**: Use to write the final campaign plan document.
|
|
75
|
+
- **content-creation**: Use to write the copy for the assets mapped in the campaign plan.
|
|
76
|
+
- **ui-ux**: Use to design landing pages and ad creative layouts required for the campaign.
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Kỹ năng: Lập Kế hoạch Chiến dịch (Campaign Plan) (Cross-Cutting)
|
|
2
|
+
|
|
3
|
+
## Mục đích
|
|
4
|
+
|
|
5
|
+
Xây dựng bản kế hoạch chiến dịch marketing toàn diện bao gồm mục tiêu, đối tượng hướng đến, thông điệp cốt lõi, chiến lược kênh truyền thông theo tuần, lịch trình nội dung và các chỉ số đo lường thành công.
|
|
6
|
+
|
|
7
|
+
## Khi nào sử dụng
|
|
8
|
+
|
|
9
|
+
- Khi lên kế hoạch ra mắt sản phẩm mới, thúc đẩy thu hút khách hàng tiềm năng (lead generation) hoặc chiến dịch nhận diện thương hiệu.
|
|
10
|
+
- Khi cần thiết lập lịch trình xuất bản nội dung hàng tuần có tính liên kết chặt chẽ giữa các tài nguyên.
|
|
11
|
+
- Khi chuyển đổi các mục tiêu kinh doanh và marketing thành các nhiệm vụ cụ thể, có thể thực hiện được.
|
|
12
|
+
|
|
13
|
+
## Quy trình từng bước
|
|
14
|
+
|
|
15
|
+
### Bước 1: Xác định Mục tiêu & Đối tượng
|
|
16
|
+
- Định hình các mục tiêu SMART (ví dụ: tạo 200 khách hàng tiềm năng MQL trong vòng 6 tuần).
|
|
17
|
+
- Định nghĩa phân khúc khách hàng chính và phụ, các nỗi đau (pain points) của họ, và giai đoạn của họ trong hành trình mua hàng.
|
|
18
|
+
|
|
19
|
+
### Bước 2: Định hình Thông điệp & Điểm khác biệt
|
|
20
|
+
- Xây dựng một thông điệp chiến dịch cốt lõi và 3-4 thông điệp phụ bổ trợ, giải quyết trực tiếp nỗi đau của khách hàng.
|
|
21
|
+
- Lựa chọn các bằng chứng thuyết phục (case study, dữ liệu thực tế, lời chứng thực) để củng cố thông điệp.
|
|
22
|
+
|
|
23
|
+
### Bước 3: Chiến lược Kênh truyền thông
|
|
24
|
+
- Lựa chọn các kênh truyền thông phù hợp với hành vi của đối tượng:
|
|
25
|
+
- Sở hữu (Owned - blog, email, mạng xã hội)
|
|
26
|
+
- Lan tỏa (Earned - PR, KOLs, bài viết đối tác)
|
|
27
|
+
- Trả phí (Paid - quảng cáo tìm kiếm, quảng cáo mạng xã hội, tài trợ)
|
|
28
|
+
- Ước lượng mức độ công sức (thấp, trung bình, cao) và phân bổ ngân sách.
|
|
29
|
+
|
|
30
|
+
### Bước 4: Lập Lịch Nội dung & Phân bổ Tài nguyên
|
|
31
|
+
- Xây dựng lịch xuất bản nội dung theo tuần dưới dạng bảng.
|
|
32
|
+
- Liệt kê toàn bộ các tài sản nội dung cần sản xuất kèm mức độ ưu tiên và thời hạn hoàn thành.
|
|
33
|
+
|
|
34
|
+
### Bước 5: Chỉ số thành công & KPIs
|
|
35
|
+
- Định nghĩa các KPIs chính và phụ.
|
|
36
|
+
- Thiết lập cơ chế theo dõi số liệu và kế hoạch giảm thiểu rủi ro.
|
|
37
|
+
|
|
38
|
+
## Input yêu cầu
|
|
39
|
+
|
|
40
|
+
- **Mục tiêu Chiến dịch**: Tăng lượt đăng ký, ra mắt sản phẩm, thu hút leads, v.v...
|
|
41
|
+
- **Đối tượng mục tiêu**: Vai trò, ngành nghề, các nỗi đau/vấn đề gặp phải.
|
|
42
|
+
- **Mốc thời gian**: Thời lượng chiến dịch và các ngày ra mắt quan trọng.
|
|
43
|
+
- **Ngân sách** (Không bắt buộc): Khoảng ngân sách quảng cáo trả phí.
|
|
44
|
+
|
|
45
|
+
## Output mong đợi
|
|
46
|
+
|
|
47
|
+
- **Tóm tắt điều hành**: Mô tả ngắn gọn về chiến dịch và mục tiêu đo lường chính.
|
|
48
|
+
- **Hồ sơ đối tượng**: Tóm tắt 2-3 câu về chân dung người mua mục tiêu.
|
|
49
|
+
- **Ma trận Thông điệp**: Thông điệp chính, các điểm bổ trợ và bằng chứng đi kèm.
|
|
50
|
+
- **Bảng Lịch Nội dung**: Các cột gồm Tuần, Tài sản nội dung, Kênh truyền thông và Ghi chú.
|
|
51
|
+
- **Bảng Chỉ số Đo lường**: Danh sách các KPIs, mục tiêu số lượng và phương pháp theo dõi.
|
|
52
|
+
- **Checklist Các Bước Tiếp Theo**: Các nhiệm vụ cần thực hiện ngay để khởi động chiến dịch.
|
|
53
|
+
|
|
54
|
+
## Giọng điệu & Quy tắc
|
|
55
|
+
|
|
56
|
+
- Viết bằng giọng điệu chiến lược, cấu trúc rõ ràng và chuyên nghiệp.
|
|
57
|
+
- Đảm bảo toàn bộ mục tiêu của chiến dịch tuân thủ đúng khung SMART.
|
|
58
|
+
- Luôn thể hiện rõ sự phụ thuộc giữa các nội dung trong lịch xuất bản.
|
|
59
|
+
|
|
60
|
+
## Templates có sẵn
|
|
61
|
+
|
|
62
|
+
- Không có
|
|
63
|
+
|
|
64
|
+
## Scripts có sẵn
|
|
65
|
+
|
|
66
|
+
- Không có
|
|
67
|
+
|
|
68
|
+
## Ví dụ
|
|
69
|
+
|
|
70
|
+
Xem thư mục `examples/`.
|
|
71
|
+
|
|
72
|
+
## Liên kết với các kỹ năng khác
|
|
73
|
+
|
|
74
|
+
- **documents**: Dùng để viết tài liệu kế hoạch chiến dịch chính thức.
|
|
75
|
+
- **content-creation**: Dùng để sản xuất nội dung chi tiết theo lịch trình chiến dịch.
|
|
76
|
+
- **ui-ux**: Dùng để thiết kế trang landing page và các banner quảng cáo phục vụ chiến dịch.
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Skill: Campaign Plan (Cross-Cutting)
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Generate a comprehensive marketing campaign brief covering goals, target audience, key messaging, week-by-week channel strategy, content calendar, and success metrics.
|
|
6
|
+
|
|
7
|
+
## When to Use
|
|
8
|
+
|
|
9
|
+
- When planning a new product launch, lead-generation push, or brand awareness campaign.
|
|
10
|
+
- When you need a week-by-week content calendar mapping dependencies between assets.
|
|
11
|
+
- When translating business and marketing goals into structured, executable campaign tasks.
|
|
12
|
+
|
|
13
|
+
## Step-by-Step Process
|
|
14
|
+
|
|
15
|
+
### Step 1: Objective & Audience Definition
|
|
16
|
+
- Formulate SMART objectives (e.g., generate 200 SQLs in 6 weeks).
|
|
17
|
+
- Define primary and secondary audience segments, their pain points, and stage in the buyer's journey.
|
|
18
|
+
|
|
19
|
+
### Step 2: Messaging & Differentiation
|
|
20
|
+
- Define one core campaign message and 3-4 supporting messages tailored to pain points.
|
|
21
|
+
- Identify solid proof points (case studies, data, testimonials) to support the messaging.
|
|
22
|
+
|
|
23
|
+
### Step 3: Channel Strategy
|
|
24
|
+
- Select channels based on audience habits:
|
|
25
|
+
- Owned (blog, email, social)
|
|
26
|
+
- Earned (PR, influencer, guest posts)
|
|
27
|
+
- Paid (SEM, social ads, sponsorships)
|
|
28
|
+
- Map effort levels (low, medium, high) and budget allocations.
|
|
29
|
+
|
|
30
|
+
### Step 4: Content Calendar & Asset Mapping
|
|
31
|
+
- Build a week-by-week content calendar in table format.
|
|
32
|
+
- List all required content assets with priority and creation deadlines.
|
|
33
|
+
|
|
34
|
+
### Step 5: Success Metrics & KPIs
|
|
35
|
+
- Define primary and secondary KPIs.
|
|
36
|
+
- Establish tracking mechanisms and risk mitigation plans.
|
|
37
|
+
|
|
38
|
+
## Required Input
|
|
39
|
+
|
|
40
|
+
- **Campaign Goal**: Drive signups, product launch, lead-gen, etc.
|
|
41
|
+
- **Target Audience**: Roles, industry, pain points.
|
|
42
|
+
- **Timeline**: Campaign duration and key launch dates.
|
|
43
|
+
- **Budget Tier** (Optional): Paid media budget range.
|
|
44
|
+
|
|
45
|
+
## Expected Output
|
|
46
|
+
|
|
47
|
+
- **Executive Summary**: One-sentence summary and main measurable target.
|
|
48
|
+
- **Audience Profile**: 2-3 sentence summary of the target buyers.
|
|
49
|
+
- **Messaging Matrix**: Key message, supporting points, and proof points.
|
|
50
|
+
- **Content Calendar Table**: Columns for Week, Asset Name, Channel, and Notes.
|
|
51
|
+
- **Success Metrics Table**: List of KPIs, target numbers, and tracking methods.
|
|
52
|
+
- **Next Steps Checklist**: Actionable kick-off tasks.
|
|
53
|
+
|
|
54
|
+
## Tone & Rules
|
|
55
|
+
|
|
56
|
+
- Write in a highly structured, strategic, and professional tone.
|
|
57
|
+
- Ensure all campaign goals follow the SMART framework.
|
|
58
|
+
- Always include clear dependencies in the content calendar.
|
|
59
|
+
|
|
60
|
+
## Available Templates
|
|
61
|
+
|
|
62
|
+
- None
|
|
63
|
+
|
|
64
|
+
## Available Scripts
|
|
65
|
+
|
|
66
|
+
- None
|
|
67
|
+
|
|
68
|
+
## Examples
|
|
69
|
+
|
|
70
|
+
See `examples/` directory.
|
|
71
|
+
|
|
72
|
+
## Links to Other Skills
|
|
73
|
+
|
|
74
|
+
- **documents**: Use to write the final campaign plan document.
|
|
75
|
+
- **content-creation**: Use to write the copy for the assets mapped in the campaign plan.
|
|
76
|
+
- **ui-ux**: Use to design landing pages and ad creative layouts required for the campaign.
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Kỹ năng: Lập Kế hoạch Chiến dịch (Campaign Plan) (Cross-Cutting)
|
|
2
|
+
|
|
3
|
+
## Mục đích
|
|
4
|
+
|
|
5
|
+
Xây dựng bản kế hoạch chiến dịch marketing toàn diện bao gồm mục tiêu, đối tượng hướng đến, thông điệp cốt lõi, chiến lược kênh truyền thông theo tuần, lịch trình nội dung và các chỉ số đo lường thành công.
|
|
6
|
+
|
|
7
|
+
## Khi nào sử dụng
|
|
8
|
+
|
|
9
|
+
- Khi lên kế hoạch ra mắt sản phẩm mới, thúc đẩy thu hút khách hàng tiềm năng (lead generation) hoặc chiến dịch nhận diện thương hiệu.
|
|
10
|
+
- Khi cần thiết lập lịch trình xuất bản nội dung hàng tuần có tính liên kết chặt chẽ giữa các tài nguyên.
|
|
11
|
+
- Khi chuyển đổi các mục tiêu kinh doanh và marketing thành các nhiệm vụ cụ thể, có thể thực hiện được.
|
|
12
|
+
|
|
13
|
+
## Quy trình từng bước
|
|
14
|
+
|
|
15
|
+
### Bước 1: Xác định Mục tiêu & Đối tượng
|
|
16
|
+
- Định hình các mục tiêu SMART (ví dụ: tạo 200 khách hàng tiềm năng MQL trong vòng 6 tuần).
|
|
17
|
+
- Định nghĩa phân khúc khách hàng chính và phụ, các nỗi đau (pain points) của họ, và giai đoạn của họ trong hành trình mua hàng.
|
|
18
|
+
|
|
19
|
+
### Bước 2: Định hình Thông điệp & Điểm khác biệt
|
|
20
|
+
- Xây dựng một thông điệp chiến dịch cốt lõi và 3-4 thông điệp phụ bổ trợ, giải quyết trực tiếp nỗi đau của khách hàng.
|
|
21
|
+
- Lựa chọn các bằng chứng thuyết phục (case study, dữ liệu thực tế, lời chứng thực) để củng cố thông điệp.
|
|
22
|
+
|
|
23
|
+
### Bước 3: Chiến lược Kênh truyền thông
|
|
24
|
+
- Lựa chọn các kênh truyền thông phù hợp với hành vi của đối tượng:
|
|
25
|
+
- Sở hữu (Owned - blog, email, mạng xã hội)
|
|
26
|
+
- Lan tỏa (Earned - PR, KOLs, bài viết đối tác)
|
|
27
|
+
- Trả phí (Paid - quảng cáo tìm kiếm, quảng cáo mạng xã hội, tài trợ)
|
|
28
|
+
- Ước lượng mức độ công sức (thấp, trung bình, cao) và phân bổ ngân sách.
|
|
29
|
+
|
|
30
|
+
### Bước 4: Lập Lịch Nội dung & Phân bổ Tài nguyên
|
|
31
|
+
- Xây dựng lịch xuất bản nội dung theo tuần dưới dạng bảng.
|
|
32
|
+
- Liệt kê toàn bộ các tài sản nội dung cần sản xuất kèm mức độ ưu tiên và thời hạn hoàn thành.
|
|
33
|
+
|
|
34
|
+
### Bước 5: Chỉ số thành công & KPIs
|
|
35
|
+
- Định nghĩa các KPIs chính và phụ.
|
|
36
|
+
- Thiết lập cơ chế theo dõi số liệu và kế hoạch giảm thiểu rủi ro.
|
|
37
|
+
|
|
38
|
+
## Input yêu cầu
|
|
39
|
+
|
|
40
|
+
- **Mục tiêu Chiến dịch**: Tăng lượt đăng ký, ra mắt sản phẩm, thu hút leads, v.v...
|
|
41
|
+
- **Đối tượng mục tiêu**: Vai trò, ngành nghề, các nỗi đau/vấn đề gặp phải.
|
|
42
|
+
- **Mốc thời gian**: Thời lượng chiến dịch và các ngày ra mắt quan trọng.
|
|
43
|
+
- **Ngân sách** (Không bắt buộc): Khoảng ngân sách quảng cáo trả phí.
|
|
44
|
+
|
|
45
|
+
## Output mong đợi
|
|
46
|
+
|
|
47
|
+
- **Tóm tắt điều hành**: Mô tả ngắn gọn về chiến dịch và mục tiêu đo lường chính.
|
|
48
|
+
- **Hồ sơ đối tượng**: Tóm tắt 2-3 câu về chân dung người mua mục tiêu.
|
|
49
|
+
- **Ma trận Thông điệp**: Thông điệp chính, các điểm bổ trợ và bằng chứng đi kèm.
|
|
50
|
+
- **Bảng Lịch Nội dung**: Các cột gồm Tuần, Tài sản nội dung, Kênh truyền thông và Ghi chú.
|
|
51
|
+
- **Bảng Chỉ số Đo lường**: Danh sách các KPIs, mục tiêu số lượng và phương pháp theo dõi.
|
|
52
|
+
- **Checklist Các Bước Tiếp Theo**: Các nhiệm vụ cần thực hiện ngay để khởi động chiến dịch.
|
|
53
|
+
|
|
54
|
+
## Giọng điệu & Quy tắc
|
|
55
|
+
|
|
56
|
+
- Viết bằng giọng điệu chiến lược, cấu trúc rõ ràng và chuyên nghiệp.
|
|
57
|
+
- Đảm bảo toàn bộ mục tiêu của chiến dịch tuân thủ đúng khung SMART.
|
|
58
|
+
- Luôn thể hiện rõ sự phụ thuộc giữa các nội dung trong lịch xuất bản.
|
|
59
|
+
|
|
60
|
+
## Templates có sẵn
|
|
61
|
+
|
|
62
|
+
- Không có
|
|
63
|
+
|
|
64
|
+
## Scripts có sẵn
|
|
65
|
+
|
|
66
|
+
- Không có
|
|
67
|
+
|
|
68
|
+
## Ví dụ
|
|
69
|
+
|
|
70
|
+
Xem thư mục `examples/`.
|
|
71
|
+
|
|
72
|
+
## Liên kết với các kỹ năng khác
|
|
73
|
+
|
|
74
|
+
- **documents**: Dùng để viết tài liệu kế hoạch chiến dịch chính thức.
|
|
75
|
+
- **content-creation**: Dùng để sản xuất nội dung chi tiết theo lịch trình chiến dịch.
|
|
76
|
+
- **ui-ux**: Dùng để thiết kế trang landing page và các banner quảng cáo phục vụ chiến dịch.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Skill: Code Review (Cross-Cutting)
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Review code changes for security vulnerabilities, performance bottlenecks, correctness, and maintainability.
|
|
6
|
+
|
|
7
|
+
## When to Use
|
|
8
|
+
|
|
9
|
+
- When reviewing a pull request or code diff
|
|
10
|
+
- When checking a code change before merging
|
|
11
|
+
- When verifying security practices (OWASP Top 10, SQL injection, secrets in code)
|
|
12
|
+
- When auditing code performance (N+1 queries, complexity, memory leaks)
|
|
13
|
+
|
|
14
|
+
## Step-by-Step Process
|
|
15
|
+
|
|
16
|
+
### Step 1: Security Audit
|
|
17
|
+
- Check for OWASP Top 10 vulnerabilities (SQL injection, XSS, CSRF, etc.)
|
|
18
|
+
- Look for secrets, API keys, or hardcoded credentials
|
|
19
|
+
- Verify authentication and authorization checks
|
|
20
|
+
|
|
21
|
+
### Step 2: Performance Evaluation
|
|
22
|
+
- Identify N+1 query problems in database interactions
|
|
23
|
+
- Look for memory leaks or high memory allocation loops
|
|
24
|
+
- Verify algorithmic complexity in critical code paths
|
|
25
|
+
|
|
26
|
+
### Step 3: Correctness Check
|
|
27
|
+
- Review edge cases (null values, empty strings, boundary conditions)
|
|
28
|
+
- Verify error handling and propagation patterns
|
|
29
|
+
- Identify race conditions or concurrency issues
|
|
30
|
+
|
|
31
|
+
### Step 4: Maintainability Review
|
|
32
|
+
- Check variable/function naming for clarity
|
|
33
|
+
- Ensure single-responsibility principle is followed
|
|
34
|
+
- Check for code duplication and readability
|
|
35
|
+
|
|
36
|
+
## Required Input
|
|
37
|
+
|
|
38
|
+
- Code diff, PR URL, or source files
|
|
39
|
+
- Context on performance constraints or security requirements
|
|
40
|
+
|
|
41
|
+
## Expected Output
|
|
42
|
+
|
|
43
|
+
- Code review report containing:
|
|
44
|
+
- Overall summary
|
|
45
|
+
- Critical security/correctness issues with severity levels
|
|
46
|
+
- Actionable improvement suggestions
|
|
47
|
+
- Praise for well-written code
|
|
48
|
+
|
|
49
|
+
## Tone & Rules
|
|
50
|
+
|
|
51
|
+
- Be constructive and focus on the code, not the developer.
|
|
52
|
+
- Provide concrete code examples when suggesting improvements.
|
|
53
|
+
- Explicitly state trade-offs (e.g. readability vs. performance).
|
|
54
|
+
|
|
55
|
+
## Available Templates
|
|
56
|
+
|
|
57
|
+
- None
|
|
58
|
+
|
|
59
|
+
## Available Scripts
|
|
60
|
+
|
|
61
|
+
- None
|
|
62
|
+
|
|
63
|
+
## Examples
|
|
64
|
+
|
|
65
|
+
See `examples/` directory.
|
|
66
|
+
|
|
67
|
+
## Links to Other Skills
|
|
68
|
+
|
|
69
|
+
- **unit-test**: Use to write test cases for edge cases identified during review.
|
|
70
|
+
- **sourcecode-analyzer**: Use for automated static code analysis.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Kỹ năng: Đánh giá Code (Code Review) (Cross-Cutting)
|
|
2
|
+
|
|
3
|
+
## Mục đích
|
|
4
|
+
|
|
5
|
+
Đánh giá các thay đổi trong mã nguồn để phát hiện lỗ hổng bảo mật, thắt nút cổ chai hiệu năng, tính chính xác và khả năng bảo trì.
|
|
6
|
+
|
|
7
|
+
## Khi nào sử dụng
|
|
8
|
+
|
|
9
|
+
- Khi đánh giá pull request hoặc code diff
|
|
10
|
+
- Khi kiểm tra mã nguồn trước khi merge
|
|
11
|
+
- Khi xác minh các tiêu chuẩn bảo mật (OWASP Top 10, SQL injection, lộ lọt secrets)
|
|
12
|
+
- Khi kiểm toán hiệu năng (truy vấn N+1, rò rỉ bộ nhớ, độ phức tạp thuật toán)
|
|
13
|
+
|
|
14
|
+
## Quy trình từng bước
|
|
15
|
+
|
|
16
|
+
### Bước 1: Kiểm toán Bảo mật
|
|
17
|
+
- Kiểm tra các lỗi bảo mật thuộc OWASP Top 10 (SQL injection, XSS, CSRF,...)
|
|
18
|
+
- Tìm kiếm các chuỗi khóa bí mật, API keys hoặc thông tin đăng nhập bị hardcode
|
|
19
|
+
- Xác minh các bước kiểm tra xác thực và phân quyền
|
|
20
|
+
|
|
21
|
+
### Bước 2: Đánh giá Hiệu năng
|
|
22
|
+
- Phát hiện các vấn đề truy vấn N+1 khi tương tác với database
|
|
23
|
+
- Tìm kiếm rò rỉ bộ nhớ hoặc các vòng lặp cấp phát bộ nhớ quá lớn
|
|
24
|
+
- Xác minh độ phức tạp thuật toán trong các luồng xử lý quan trọng
|
|
25
|
+
|
|
26
|
+
### Bước 3: Kiểm tra Tính chính xác
|
|
27
|
+
- Đánh giá các trường hợp biên (giá trị null, chuỗi rỗng, giá trị giới hạn)
|
|
28
|
+
- Xác minh cơ chế xử lý lỗi và truyền lỗi (error propagation)
|
|
29
|
+
- Phát hiện các lỗi bất đồng bộ (race conditions, concurrency)
|
|
30
|
+
|
|
31
|
+
### Bước 4: Đánh giá Khả năng bảo trì
|
|
32
|
+
- Kiểm tra cách đặt tên biến/hàm xem đã rõ ràng chưa
|
|
33
|
+
- Đảm bảo tuân thủ nguyên tắc đơn nhiệm (Single Responsibility Principle)
|
|
34
|
+
- Kiểm tra trùng lặp mã nguồn và độ dễ đọc của code
|
|
35
|
+
|
|
36
|
+
## Input yêu cầu
|
|
37
|
+
|
|
38
|
+
- Code diff, PR URL hoặc các file mã nguồn cần review
|
|
39
|
+
- Ngữ cảnh về các ràng buộc hiệu năng hoặc yêu cầu bảo mật đặc thù
|
|
40
|
+
|
|
41
|
+
## Output mong đợi
|
|
42
|
+
|
|
43
|
+
- Báo cáo review code bao gồm:
|
|
44
|
+
- Tóm tắt tổng quan về chất lượng
|
|
45
|
+
- Danh sách lỗi nghiêm trọng kèm mức độ nghiêm trọng
|
|
46
|
+
- Đề xuất cải tiến có thể thực thi kèm code mẫu
|
|
47
|
+
- Đánh giá các điểm viết tốt
|
|
48
|
+
|
|
49
|
+
## Giọng điệu & Quy tắc
|
|
50
|
+
|
|
51
|
+
- Đưa ra phản hồi mang tính xây dựng, tập trung vào code thay vì nhà phát triển.
|
|
52
|
+
- Cung cấp ví dụ code thực tế khi đề xuất cải tiến.
|
|
53
|
+
- Làm rõ các yếu tố đánh đổi (ví dụ: độ dễ đọc vs. hiệu năng tối ưu).
|
|
54
|
+
|
|
55
|
+
## Templates có sẵn
|
|
56
|
+
|
|
57
|
+
- Không có
|
|
58
|
+
|
|
59
|
+
## Scripts có sẵn
|
|
60
|
+
|
|
61
|
+
- Không có
|
|
62
|
+
|
|
63
|
+
## Ví dụ
|
|
64
|
+
|
|
65
|
+
Xem thư mục `examples/`.
|
|
66
|
+
|
|
67
|
+
## Liên kết với các kỹ năng khác
|
|
68
|
+
|
|
69
|
+
- **unit-test**: Dùng để viết test cases cho các trường hợp biên được phát hiện khi review.
|
|
70
|
+
- **sourcecode-analyzer**: Dùng để phân tích tĩnh mã nguồn tự động.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Skill: Code Review (Cross-Cutting)
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Review code changes for security vulnerabilities, performance bottlenecks, correctness, and maintainability.
|
|
6
|
+
|
|
7
|
+
## When to Use
|
|
8
|
+
|
|
9
|
+
- When reviewing a pull request or code diff
|
|
10
|
+
- When checking a code change before merging
|
|
11
|
+
- When verifying security practices (OWASP Top 10, SQL injection, secrets in code)
|
|
12
|
+
- When auditing code performance (N+1 queries, complexity, memory leaks)
|
|
13
|
+
|
|
14
|
+
## Step-by-Step Process
|
|
15
|
+
|
|
16
|
+
### Step 1: Security Audit
|
|
17
|
+
- Check for OWASP Top 10 vulnerabilities (SQL injection, XSS, CSRF, etc.)
|
|
18
|
+
- Look for secrets, API keys, or hardcoded credentials
|
|
19
|
+
- Verify authentication and authorization checks
|
|
20
|
+
|
|
21
|
+
### Step 2: Performance Evaluation
|
|
22
|
+
- Identify N+1 query problems in database interactions
|
|
23
|
+
- Look for memory leaks or high memory allocation loops
|
|
24
|
+
- Verify algorithmic complexity in critical code paths
|
|
25
|
+
|
|
26
|
+
### Step 3: Correctness Check
|
|
27
|
+
- Review edge cases (null values, empty strings, boundary conditions)
|
|
28
|
+
- Verify error handling and propagation patterns
|
|
29
|
+
- Identify race conditions or concurrency issues
|
|
30
|
+
|
|
31
|
+
### Step 4: Maintainability Review
|
|
32
|
+
- Check variable/function naming for clarity
|
|
33
|
+
- Ensure single-responsibility principle is followed
|
|
34
|
+
- Check for code duplication and readability
|
|
35
|
+
|
|
36
|
+
## Required Input
|
|
37
|
+
|
|
38
|
+
- Code diff, PR URL, or source files
|
|
39
|
+
- Context on performance constraints or security requirements
|
|
40
|
+
|
|
41
|
+
## Expected Output
|
|
42
|
+
|
|
43
|
+
- Code review report containing:
|
|
44
|
+
- Overall summary
|
|
45
|
+
- Critical security/correctness issues with severity levels
|
|
46
|
+
- Actionable improvement suggestions
|
|
47
|
+
- Praise for well-written code
|
|
48
|
+
|
|
49
|
+
## Tone & Rules
|
|
50
|
+
|
|
51
|
+
- Be constructive and focus on the code, not the developer.
|
|
52
|
+
- Provide concrete code examples when suggesting improvements.
|
|
53
|
+
- Explicitly state trade-offs (e.g. readability vs. performance).
|
|
54
|
+
|
|
55
|
+
## Available Templates
|
|
56
|
+
|
|
57
|
+
- None
|
|
58
|
+
|
|
59
|
+
## Available Scripts
|
|
60
|
+
|
|
61
|
+
- None
|
|
62
|
+
|
|
63
|
+
## Examples
|
|
64
|
+
|
|
65
|
+
See `examples/` directory.
|
|
66
|
+
|
|
67
|
+
## Links to Other Skills
|
|
68
|
+
|
|
69
|
+
- **unit-test**: Use to write test cases for edge cases identified during review.
|
|
70
|
+
- **sourcecode-analyzer**: Use for automated static code analysis.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Kỹ năng: Đánh giá Code (Code Review) (Cross-Cutting)
|
|
2
|
+
|
|
3
|
+
## Mục đích
|
|
4
|
+
|
|
5
|
+
Đánh giá các thay đổi trong mã nguồn để phát hiện lỗ hổng bảo mật, thắt nút cổ chai hiệu năng, tính chính xác và khả năng bảo trì.
|
|
6
|
+
|
|
7
|
+
## Khi nào sử dụng
|
|
8
|
+
|
|
9
|
+
- Khi đánh giá pull request hoặc code diff
|
|
10
|
+
- Khi kiểm tra mã nguồn trước khi merge
|
|
11
|
+
- Khi xác minh các tiêu chuẩn bảo mật (OWASP Top 10, SQL injection, lộ lọt secrets)
|
|
12
|
+
- Khi kiểm toán hiệu năng (truy vấn N+1, rò rỉ bộ nhớ, độ phức tạp thuật toán)
|
|
13
|
+
|
|
14
|
+
## Quy trình từng bước
|
|
15
|
+
|
|
16
|
+
### Bước 1: Kiểm toán Bảo mật
|
|
17
|
+
- Kiểm tra các lỗi bảo mật thuộc OWASP Top 10 (SQL injection, XSS, CSRF,...)
|
|
18
|
+
- Tìm kiếm các chuỗi khóa bí mật, API keys hoặc thông tin đăng nhập bị hardcode
|
|
19
|
+
- Xác minh các bước kiểm tra xác thực và phân quyền
|
|
20
|
+
|
|
21
|
+
### Bước 2: Đánh giá Hiệu năng
|
|
22
|
+
- Phát hiện các vấn đề truy vấn N+1 khi tương tác với database
|
|
23
|
+
- Tìm kiếm rò rỉ bộ nhớ hoặc các vòng lặp cấp phát bộ nhớ quá lớn
|
|
24
|
+
- Xác minh độ phức tạp thuật toán trong các luồng xử lý quan trọng
|
|
25
|
+
|
|
26
|
+
### Bước 3: Kiểm tra Tính chính xác
|
|
27
|
+
- Đánh giá các trường hợp biên (giá trị null, chuỗi rỗng, giá trị giới hạn)
|
|
28
|
+
- Xác minh cơ chế xử lý lỗi và truyền lỗi (error propagation)
|
|
29
|
+
- Phát hiện các lỗi bất đồng bộ (race conditions, concurrency)
|
|
30
|
+
|
|
31
|
+
### Bước 4: Đánh giá Khả năng bảo trì
|
|
32
|
+
- Kiểm tra cách đặt tên biến/hàm xem đã rõ ràng chưa
|
|
33
|
+
- Đảm bảo tuân thủ nguyên tắc đơn nhiệm (Single Responsibility Principle)
|
|
34
|
+
- Kiểm tra trùng lặp mã nguồn và độ dễ đọc của code
|
|
35
|
+
|
|
36
|
+
## Input yêu cầu
|
|
37
|
+
|
|
38
|
+
- Code diff, PR URL hoặc các file mã nguồn cần review
|
|
39
|
+
- Ngữ cảnh về các ràng buộc hiệu năng hoặc yêu cầu bảo mật đặc thù
|
|
40
|
+
|
|
41
|
+
## Output mong đợi
|
|
42
|
+
|
|
43
|
+
- Báo cáo review code bao gồm:
|
|
44
|
+
- Tóm tắt tổng quan về chất lượng
|
|
45
|
+
- Danh sách lỗi nghiêm trọng kèm mức độ nghiêm trọng
|
|
46
|
+
- Đề xuất cải tiến có thể thực thi kèm code mẫu
|
|
47
|
+
- Đánh giá các điểm viết tốt
|
|
48
|
+
|
|
49
|
+
## Giọng điệu & Quy tắc
|
|
50
|
+
|
|
51
|
+
- Đưa ra phản hồi mang tính xây dựng, tập trung vào code thay vì nhà phát triển.
|
|
52
|
+
- Cung cấp ví dụ code thực tế khi đề xuất cải tiến.
|
|
53
|
+
- Làm rõ các yếu tố đánh đổi (ví dụ: độ dễ đọc vs. hiệu năng tối ưu).
|
|
54
|
+
|
|
55
|
+
## Templates có sẵn
|
|
56
|
+
|
|
57
|
+
- Không có
|
|
58
|
+
|
|
59
|
+
## Scripts có sẵn
|
|
60
|
+
|
|
61
|
+
- Không có
|
|
62
|
+
|
|
63
|
+
## Ví dụ
|
|
64
|
+
|
|
65
|
+
Xem thư mục `examples/`.
|
|
66
|
+
|
|
67
|
+
## Liên kết với các kỹ năng khác
|
|
68
|
+
|
|
69
|
+
- **unit-test**: Dùng để viết test cases cho các trường hợp biên được phát hiện khi review.
|
|
70
|
+
- **sourcecode-analyzer**: Dùng để phân tích tĩnh mã nguồn tự động.
|