Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
185 changes: 185 additions & 0 deletions packages/fiori-docs-embeddings/data_local/SKILLS_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
---
name: [kebab-case-skill-identifier]
description: '[One clear sentence describing what this skill accomplishes and when to use it. Use for: specific use case 1, specific use case 2, specific use case 3.]'
argument-hint: '[expected parameters, inputs, or field names needed for this skill]'
---

# [Skill Title]

## Goal
[One clear sentence describing what this skill accomplishes]

## Context
[Brief explanation of when/why you would use this skill - 1-2 sentences]

## Prerequisites
- [Required tool/framework/setup #1]
- [Required tool/framework/setup #2]
- [Required knowledge/file #3]
- [Required condition #4]

## Steps

### 1. [Step Name - Gather Information/Requirements]

[Brief description of what needs to be determined or gathered]

Ask the user to clarify:
- [Question/requirement #1]
- [Question/requirement #2]
- [Question/requirement #3]

### 2. [Step Name - First Technical Action]

[Brief description of what this step accomplishes]

**File:** `path/to/file`

```language
// Code example showing the implementation
// Keep it focused on this specific step
// Use placeholders like EntityName, FieldName, etc.
```

[Optional bullet points for additional context]
- [Important detail #1]
- [Important detail #2]

### 3. [Step Name - Second Technical Action]

[Brief description]

**File:** `path/to/another/file`

```language
// Another code example
// Show the pattern clearly
```

### 4. [Step Name - Continue Pattern]

[Keep adding steps as needed, typically 5-8 steps total]

**File:** `path/to/file`

```language
// Code example
```

### [N]. [Step Name - Final Step - Usually Testing]

[Description of how to test/verify the implementation]

```bash
# Command to run
```

Verify:
- [Expected result #1]
- [Expected result #2]
- [Expected result #3]

## [Reference Section Title - e.g., "Configuration Options"]

| Option | Description |
|--------|-------------|
| `Value1` | What it does |
| `Value2` | What it does |
| `Value3` | What it does |

## [Another Reference Section - e.g., "Common Patterns"]

**[Pattern Name]:**
```language
// Code showing this pattern
```

**[Another Pattern Name]:**
```language
// Code showing another pattern
```

## Common Issues

**[Problem description]:**
- [Solution point #1]
- [Solution point #2]
- [Solution point #3]

**[Another problem description]:**
- [Solution point #1]
- [Solution point #2]

**[Third problem description]:**
- [Solution point #1]
- [Solution point #2]

## Example Use Cases

- [Real-world scenario #1]
- [Real-world scenario #2]
- [Real-world scenario #3]
- [Real-world scenario #4]
- [Real-world scenario #5]

## Notes

- [Best practice or important consideration #1]
- [Best practice or important consideration #2]
- [Best practice or important consideration #3]
- [Performance tip or caveat]
- [Recommendation for complex scenarios]

---

## Template Usage Instructions

### Sections to Always Include:
1. **Skill ID** - Unique kebab-case identifier for the skill
2. **Goal** - Single sentence, action-oriented
3. **Context** - Brief "when to use" explanation
4. **Prerequisites** - Bulleted list of requirements
5. **Steps** - Numbered, clear action steps with code examples
6. **Common Issues** - Troubleshooting guide
7. **Example Use Cases** - Real-world scenarios
8. **Notes** - Best practices and tips

### Optional Sections (use as needed):
- Reference tables (configuration options, types, etc.)
- Common patterns section
- Advanced configurations
- Related skills

### Writing Guidelines:
- **Be concise** - Short paragraphs, clear actions
- **Use code examples** - Show, don't just tell
- **Use placeholders** - Generic names like `EntityName`, `FieldName`
- **Number steps clearly** - Each step should be actionable
- **Include verification** - Last step should verify success
- **Think troubleshooting** - Address common issues proactively

### Code Example Format:
```language
// Use comments to explain key parts
// Keep examples focused and minimal
// Use consistent placeholder naming
```

### File Reference Format:
**File:** `path/to/file` (always before code blocks)

### Step Title Format:
"### N. [Action Verb] [What]" - e.g., "### 3. Configure Service Layer"

### Common Issues Format:
**[Problem in user terms]:**
- [Bullet-point solutions]
- [Keep solutions actionable]

### Best Practices:
- Start with information gathering
- End with testing/verification
- Keep each step focused on ONE thing
- Use tables for reference information
- Consider the user's perspective
- Make it scannable - use formatting
Loading
Loading