Skip to content

Commit fb2cbf2

Browse files
Updated the document sdk skill file
1 parent 6972f8a commit fb2cbf2

2 files changed

Lines changed: 117 additions & 29 deletions

File tree

Document-Processing-toc.html

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,22 @@
88
</li>
99
<li>
1010
<a href="/document-processing/System-Requirements">System Requirements</a>
11+
</li>
12+
<li>Skills
13+
<ul>
14+
<li>
15+
<a href="/document-processing/Skills/document-sdk">Document SDK</a>
16+
</li>
17+
<li>
18+
<a href="/document-processing/Skills/pdf-viewer-sdk">PDF Viewer SDK</a>
19+
</li>
20+
<li>
21+
<a href="/document-processing/Skills/docx-editor-sdk">DOCX Editor SDK</a>
22+
</li>
23+
<li>
24+
<a href="/document-processing/Skills/spreadsheet-editor-sdk">Spreadsheet Editor SDK</a>
25+
</li>
26+
</ul>
1127
</li>
1228
<li>AI Coding Assistant
1329
<ul>
@@ -114,7 +130,7 @@
114130
<a href="/document-processing/nuget-packages">NuGet Packages</a>
115131
</li>
116132
<li>
117-
<a href="/document-processing/data-extraction/overview">DataExtraction</a>
133+
<a href="/document-processing/data-extraction/overview">Data Extraction</a>
118134
<ul>
119135
<li>
120136
<a href="/document-processing/data-extraction/smart-data-extractor/overview">Smart Data Extractor</a>

Document-Processing/Skills/document-sdk.md

Lines changed: 100 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ Syncfusion<sup style="font-size:70%">&reg;</sup> Document SDK Skills eliminate c
1515

1616
| Document Processing Libraries | Skills |
1717
|---|---|
18-
| [Word (DocIO)](https://help.syncfusion.com/document-processing/word/overview) | syncfusion-dotnet-word <br> syncfusion-java-word |
19-
| [PDF](https://help.syncfusion.com/document-processing/pdf/overview) | syncfusion-dotnet-pdf <br> syncfusion-dotnet-pdf-to-image <br> syncfusion-flutter-pdf <br> syncfusion-javascript-pdf |
20-
| [Excel (XlsIO)](https://help.syncfusion.com/document-processing/excel/overview) | syncfusion-dotnet-excel <br> syncfusion-flutter-excel |
21-
| [PowerPoint (Presentation)](https://help.syncfusion.com/document-processing/powerpoint/overview) | syncfusion-dotnet-powerpoint |
22-
| [Markdown](https://help.syncfusion.com/document-processing/word/word-library/net/convert-markdown-to-word-document-in-csharp) | syncfusion-dotnet-markdown |
23-
| [Smart Data Extraction](https://help.syncfusion.com/document-processing/data-extraction/overview) | syncfusion-dotnet-smart-data-extraction |
18+
| [Word (DocIO)](https://help.syncfusion.com/document-processing/word/word-library/overview) | [syncfusion-dotnet-word <br> syncfusion-java-word](https://github.com/syncfusion/document-sdk-skills/tree/main/skills/syncfusion-java-word) |
19+
| [PDF](https://help.syncfusion.com/document-processing/pdf/pdf-library/overview) | [syncfusion-dotnet-pdf](https://github.com/syncfusion/document-sdk-skills/tree/main/skills/syncfusion-dotnet-pdf) <br> [syncfusion-dotnet-pdf-to-image](https://github.com/syncfusion/document-sdk-skills/tree/main/skills/syncfusion-dotnet-pdf-to-image) <br> [syncfusion-flutter-pdf](https://github.com/syncfusion/document-sdk-skills/tree/main/skills/syncfusion-flutter-pdf) <br> [syncfusion-javascript-pdf](https://github.com/syncfusion/document-sdk-skills/tree/main/skills/syncfusion-javascript-pdf) |
20+
| [Excel (XlsIO)](https://help.syncfusion.com/document-processing/excel/excel-library/overview) | [syncfusion-dotnet-excel](https://github.com/syncfusion/document-sdk-skills/tree/main/skills/syncfusion-dotnet-excel) <br> [syncfusion-flutter-excel](https://github.com/syncfusion/document-sdk-skills/tree/main/skills/syncfusion-flutter-excel) |
21+
| [PowerPoint (Presentation)](https://help.syncfusion.com/document-processing/powerpoint/powerpoint-library/overview) | [syncfusion-dotnet-powerpoint](https://github.com/syncfusion/document-sdk-skills/tree/main/skills/syncfusion-dotnet-powerpoint) |
22+
| [Markdown](https://help.syncfusion.com/document-processing/word/word-library/net/convert-markdown-to-word-document-in-csharp) | [syncfusion-dotnet-markdown](https://github.com/syncfusion/document-sdk-skills/tree/main/skills/syncfusion-dotnet-markdown) |
23+
| [Smart Data Extraction](https://help.syncfusion.com/document-processing/data-extraction/overview) | [syncfusion-dotnet-smart-data-extraction](https://github.com/syncfusion/document-sdk-skills/tree/main/skills/syncfusion-dotnet-smart-data-extraction) |
2424

2525
## Prerequisites
2626

@@ -32,43 +32,115 @@ Before installing Syncfusion<sup style="font-size:70%">&reg;</sup> Document SDK
3232

3333
## Installation
3434

35-
Choose one of the following commands to install Syncfusion<sup style="font-size:70%">&reg;</sup> Document SDK Skills based on your preference. You can also explore Syncfusion<sup style="font-size:70%">&reg;</sup> skills from the [marketplace](https://skills.sh/syncfusion/).
35+
Choose one of the following commands to install [Syncfusion<sup style="font-size:70%">&reg;</sup> Document SDK Skills](https://github.com/syncfusion/document-sdk-skills) based on your preference. You can also explore Syncfusion<sup style="font-size:70%">&reg;</sup> skills from the [marketplace](https://skills.sh/syncfusion/).
3636

3737
To install all document SDK skills at once, use the following command:
3838

39-
```bash
39+
{% tabs %}
40+
{% highlight bash tabtitle="npm" %}
41+
4042
npx skills add syncfusion/document-sdk-skills --all -y
41-
```
43+
44+
{% endhighlight %}
45+
{% endtabs %}
4246

4347
To install a specific skill, use the following command (for example, to install PDF .NET skills):
4448

45-
```bash
49+
{% tabs %}
50+
{% highlight bash tabtitle="npm" %}
51+
4652
npx skills add syncfusion/document-sdk-skills --skill syncfusion-dotnet-pdf
47-
```
4853

49-
This registers the Syncfusion<sup style="font-size:70%">&reg;</sup> skill pack so your AI assistant can automatically load it in supported IDEs such as [Code Studio](https://help.syncfusion.com/code-studio/reference/configure-properties/skills), [Visual Studio Code](https://code.visualstudio.com/docs/copilot/customization/agent-skills), and [Cursor](https://cursor.com/docs/skills).
54+
{% endhighlight %}
55+
{% endtabs %}
5056

51-
To learn more about the Skills CLI, refer [here](https://skills.sh/docs).
57+
Choose and install skills interactively from the terminal:
58+
59+
{% tabs %}
60+
{% highlight bash tabtitle="npm" %}
61+
62+
npx skills add syncfusion/document-sdk-skills
63+
64+
{% endhighlight %}
65+
{% endtabs %}
66+
67+
The terminal will show a list of available skills. Use the arrow keys to navigate, space bar to select the skills you want, and Enter to confirm.
68+
69+
{% tabs %}
70+
{% highlight bash tabtitle="npm" %}
5271

53-
## What's Included
72+
Select skills to install (space to toggle)
73+
│ ◻ syncfusion-dotnet-pdf
74+
│ ◻ syncfusion-dotnet-word
75+
│ ◻ syncfusion-dotnet-excel
76+
│ ◻ syncfusion-dotnet-powerpoint
77+
│ ◻ syncfusion-dotnet-markdown
78+
│ ◻ syncfusion-dotnet-smart-data-extraction
79+
│ ◻ syncfusion-java-word
80+
│ ◻ syncfusion-flutter-pdf
81+
│ ◻ syncfusion-javascript-pdf
82+
│ .....
5483

55-
1. **Document SDK API Knowledge** — Curated, skill-based guidance for creating, editing, and converting PDF, Word, Excel, PowerPoint, and Markdown documents using Syncfusion<sup style="font-size:70%">&reg;</sup> Document SDK libraries. Covers key APIs, supported formats, and conversions.
56-
2. **Dual-Mode Execution (.NET)** — Supports two operating modes:
57-
- **Mode 1** — Generate production-ready code for your project.
58-
- **Mode 2** — Execute a document task immediately via a CSX script without modifying your project.
59-
3. **Patterns & Best Practices** — Practical recommendations for API usage, platform-specific NuGet package selection, and document processing workflows (for example, mail merge, PDF digital signatures, Excel pivot tables, and PowerPoint chart creation). All guidance is authored directly within the skill file rather than being fetched from external documentation.
84+
{% endhighlight %}
85+
{% endtabs %}
6086

87+
Next, select which AI agent you're using and where to store the skills.
88+
{% tabs %}
89+
{% highlight bash tabtitle="npm" %}
6190

62-
## How Syncfusion<sup style="font-size:70%">&reg;</sup> Document SDK Agent Skills Work
91+
│ ── Additional agents ─────────────────────────────
92+
│ Search:
93+
│ ↑↓ move, space select, enter confirm
94+
95+
│ ❯ ○ Augment (.augment/skills)
96+
│ ○ Claude Code (.claude/skills)
97+
│ ○ OpenClaw (skills)
98+
│ ○ CodeBuddy (.codebuddy/skills)
99+
│ ○ Command Code (.commandcode/skills)
100+
│ ○ Continue (.continue/skills)
101+
│ ○ Cortex Code (.cortex/skills)
102+
│ ○ Crush (.crush/skills)
103+
| ....
104+
105+
{% endhighlight %}
106+
{% endtabs %}
107+
108+
Choose your installation scope (project-level or global), then confirm to complete the installation.
109+
110+
{% tabs %}
111+
{% highlight bash tabtitle="npm" %}
112+
113+
◆ Installation scope
114+
│ ● Project (Install in current directory (committed with your project))
115+
│ ○ Global
116+
117+
◆ Proceed with installation?
118+
│ ● Yes / ○ No
119+
120+
{% endhighlight %}
121+
{% endtabs %}
122+
123+
This registers the Syncfusion<sup style="font-size:70%">&reg;</sup> skill pack so your AI assistant can automatically load it in supported IDEs such as [Code Studio](https://help.syncfusion.com/code-studio/reference/configure-properties/skills), [Visual Studio Code](https://code.visualstudio.com/docs/copilot/customization/agent-skills), and [Cursor](https://cursor.com/docs/skills).
124+
125+
To learn more about the Skills CLI, refer [here](https://skills.sh/docs).
63126

64-
1. **Read the relevant skill files and choose modes based on the user's query** The assistant retrieves library APIs, and code patterns from the installed Syncfusion<sup style="font-size:70%">&reg;</sup> Skills. It automatically chooses the appropriate operating mode based on the provided prompt.
65-
2. **Enforces Syncfusion<sup style="font-size:70%">&reg;</sup> best practices**, including:
66-
- Suggesting the correct NuGet packages or JAR files based on the detected application type.
67-
- Using only APIs and code patterns explicitly present in the skill reference files.
68-
- Configuring the Syncfusion<sup style="font-size:70%">&reg;</sup> license key from `SyncfusionLicense.txt` or the `SYNCFUSION_LICENSE_KEY` environment variable.
69-
3. **Operates in two modes** based on the user's intent:
70-
- **Mode 1 — Generate Code**: Produces production-ready code. No scripts are created or executed. Triggered by keywords such as `"code"`, `"snippet"`, `"how to"`, `"show me"`, `"sample"`, or `"example"`.
71-
- **Mode 2 — Execute via CSX Script**: Creates a temporary `.csx` script, runs it with `dotnet script`, produces the output document file, then cleans up — without modifying the user's project. Triggered by keywords such as `"create"`, `"generate"`, `"make"`, `"open"`, `"edit"`, `"modify"`, or a file path (e.g., `output/report.docx`).
127+
## Capabilities and How It Works
128+
129+
Each installed skill pack provides the following capabilities:
130+
131+
- **Document SDK API Knowledge** — Curated guidance covering key APIs, supported file formats, and conversion workflows for PDF, Word, Excel, PowerPoint, and Markdown. The assistant reads the skill files to retrieve relevant APIs and code patterns, then automatically selects the appropriate mode based on the prompt.
132+
133+
- **Patterns and Best Practices** — Guidance on API usage, NuGet package selection, and common workflows (mail merge, PDF digital signatures, Excel pivot tables, and PowerPoint chart creation). The assistant enforces these standards in every response:
134+
- Recommends the correct NuGet packages or JAR files based on the application type.
135+
- Uses only APIs and code patterns defined in the skill reference files.
136+
- Configures the Syncfusion<sup style="font-size:70%">&reg;</sup> license key from `SyncfusionLicense.txt` or the `SYNCFUSION_LICENSE_KEY` environment variable.
137+
138+
- **Dual-Mode Execution (.NET)** — The assistant automatically selects a mode based on keywords in the prompt:
139+
140+
| Mode | Description | Trigger Keywords |
141+
|---|---|---|
142+
| **Mode 1 — Generate Code** | Produces production-ready code for your project. No scripts are created or executed. | `"code"`, `"snippet"`, `"how to"`, `"show me"`, `"sample"`, `"example"` |
143+
| **Mode 2 — Execute via CSX Script** | Creates and runs a temporary `.csx` script using `dotnet script`, produces the output document, then removes the script — without modifying your project. | `"create"`, `"generate"`, `"make"`, `"open"`, `"edit"`, `"modify"`, or a file path |
72144

73145
## Using the AI Assistant
74146

0 commit comments

Comments
 (0)