Skip to content

Commit 8d10757

Browse files
Addressed the feed backs
1 parent f1630b6 commit 8d10757

1 file changed

Lines changed: 18 additions & 16 deletions

File tree

Document-Processing/Skills/document-sdk.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Before installing Syncfusion<sup style="font-size:70%">&reg;</sup> Document SDK
2929
- **[Node.js](https://nodejs.org/en)** (v18 or later) — Required to run `npx` commands for installing skills.
3030
- **[.NET SDK](https://dotnet.microsoft.com/en-us/download)** (8.0 or later) — Required for CSX script execution (Mode 2).
3131
- **[dotnet-script](https://github.com/dotnet-script/dotnet-script)** — Required for CSX script execution (Mode 2). Install it globally by running: `dotnet tool install -g dotnet-script`.
32+
- A supported AI agent or IDE that integrates with the Skills CLI (VS Code, Syncfusion® Code Studio, Cursor, etc.)
3233

3334
## Installation
3435

@@ -39,7 +40,7 @@ To install all document SDK skills at once, use the following command:
3940
{% tabs %}
4041
{% highlight bash tabtitle="npm" %}
4142

42-
npx skills add syncfusion/document-sdk-skills --all -y
43+
npx skills add syncfusion/document-sdk-skills -y
4344

4445
{% endhighlight %}
4546
{% endtabs %}
@@ -124,25 +125,26 @@ This registers the Syncfusion<sup style="font-size:70%">&reg;</sup> skill pack s
124125

125126
To learn more about the Skills CLI, refer [here](https://skills.sh/docs).
126127

127-
## Capabilities and How It Works
128+
## How Syncfusion<sup style="font-size:70%">&reg;</sup> Document SDK Agent Skills Work
128129

129-
Each installed skill pack provides the following capabilities:
130+
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.
130131

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:
132+
2. **Operates in two modes** based on the user's intent:
133+
134+
- **Mode 1 — Generate Code**:
135+
136+
- Triggered when the prompt includes keywords such as "code", "snippet", "how to", "show me", "sample", or "example".
137+
- Detects the application type and recommends the required NuGet packages.
138+
- Generates production-ready code by referencing the appropriate `references/*.md` files for the requested feature.
139+
140+
- **Mode 2 — Execute via CSX Script**:
141+
- Triggered by keywords such as "create", "generate", "make", "open", "edit", "modify", or when a file path is provided (e.g., `output/report.docx`).
142+
- Creates a temporary .csx script by inserting the appropriate code snippet from the relevant references/*.md files.
143+
- Executes the script using dotnet script, generates the output document, and then performs cleanup — all without modifying the user's project.
139144

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 |
145+
3. **Register licensing key** Configuring the Syncfusion<sup style="font-size:70%">&reg;</sup> license key from `SyncfusionLicense.txt` or the `SYNCFUSION_LICENSE_KEY` environment variable.
144146

145-
## Using the AI Assistant
147+
### Using the AI Assistant
146148

147149
Once skills are installed, the assistant can generate Syncfusion<sup style="font-size:70%">&reg;</sup> document processing code or execute document generation tasks. Below are example prompts for each mode.
148150

0 commit comments

Comments
 (0)