@uipath/delegate-sdk 1.203.1 → 1.203.3
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/README.md +41 -3
- package/dist/index.mjs +2 -2
- package/dist/skills/business-analysis/SKILL.md +729 -0
- package/dist/skills/business-analysis/as-is-capture.md +444 -0
- package/dist/skills/business-analysis/assets/progress.yaml +19 -0
- package/dist/skills/business-analysis/assets/task-list.md +34 -0
- package/dist/skills/business-analysis/automation-hub-publishing.md +47 -0
- package/dist/skills/business-analysis/bpmn-to-be-design.md +274 -0
- package/dist/skills/business-analysis/case-to-be-design.md +223 -0
- package/dist/skills/business-analysis/diagram-authoring.md +224 -0
- package/dist/skills/business-analysis/industry-gaps.md +134 -0
- package/dist/skills/business-analysis/interview-spine.md +297 -0
- package/dist/skills/business-analysis/locales/de.json +54 -0
- package/dist/skills/business-analysis/locales/en.json +54 -0
- package/dist/skills/business-analysis/locales/es-MX.json +54 -0
- package/dist/skills/business-analysis/locales/es.json +54 -0
- package/dist/skills/business-analysis/locales/fr.json +54 -0
- package/dist/skills/business-analysis/locales/ja.json +54 -0
- package/dist/skills/business-analysis/locales/ko.json +54 -0
- package/dist/skills/business-analysis/locales/pt-BR.json +54 -0
- package/dist/skills/business-analysis/locales/pt.json +54 -0
- package/dist/skills/business-analysis/locales/ro.json +54 -0
- package/dist/skills/business-analysis/locales/tr.json +54 -0
- package/dist/skills/business-analysis/locales/zh-CN.json +54 -0
- package/dist/skills/business-analysis/locales/zh-TW.json +54 -0
- package/dist/skills/business-analysis/pdd-generation.md +204 -0
- package/dist/skills/business-analysis/pdd-template.md +562 -0
- package/dist/skills/business-analysis/progress-presentation.json +13 -0
- package/dist/skills/business-analysis/recording-first.md +19 -0
- package/dist/skills/business-analysis/recording-processing.md +152 -0
- package/dist/skills/business-analysis/references/automation-hub-open-api.md +57 -0
- package/dist/skills/business-analysis/references/case-definition-spec.md +90 -0
- package/dist/skills/business-analysis/references/case-design-patterns/loan-origination-spec.md +86 -0
- package/dist/skills/business-analysis/references/component-type-mapping.md +52 -0
- package/dist/skills/business-analysis/references/uipath-products/case-management-schema.md +62 -0
- package/dist/skills/business-analysis/references/uipath-products/maestro-case-framework.md +65 -0
- package/dist/skills/business-analysis/references/uipath-products/maestro-case-management.md +49 -0
- package/dist/skills/business-analysis/research-offer.md +104 -0
- package/dist/skills/business-analysis/research-pass.md +149 -0
- package/dist/skills/business-analysis/scripts/assemble-pdd.ps1 +294 -0
- package/dist/skills/business-analysis/scripts/assemble-pdd.sh +453 -0
- package/dist/skills/business-analysis/scripts/check-phase-ready.ps1 +72 -0
- package/dist/skills/business-analysis/scripts/check-phase-ready.sh +98 -0
- package/dist/skills/business-analysis/scripts/lint-diagram.ps1 +524 -0
- package/dist/skills/business-analysis/scripts/lint-diagram.sh +519 -0
- package/dist/skills/business-analysis/scripts/stamp-pages.ps1 +363 -0
- package/dist/skills/business-analysis/scripts/stamp-pages.sh +360 -0
- package/dist/skills/business-analysis/to-be-design.md +199 -0
- package/dist/skills/confluence/SKILL.md +386 -0
- package/dist/skills/doc-coauthoring/SKILL.md +295 -0
- package/dist/skills/excel-architect/SKILL.macos.md +161 -0
- package/dist/skills/excel-architect/SKILL.md +180 -0
- package/dist/skills/excel-architect/SKILL.windows.md +61 -0
- package/dist/skills/excel-architect/archetypes/01-financial-model-advanced.md +332 -0
- package/dist/skills/excel-architect/archetypes/01-financial-model.md +248 -0
- package/dist/skills/excel-architect/archetypes/02-data-analysis.md +171 -0
- package/dist/skills/excel-architect/archetypes/03-tracking-dashboard.md +160 -0
- package/dist/skills/excel-architect/archetypes/04-project-planning.md +193 -0
- package/dist/skills/excel-architect/archetypes/05-simple-table.md +111 -0
- package/dist/skills/excel-architect/building.md +279 -0
- package/dist/skills/excel-architect/create.md +64 -0
- package/dist/skills/excel-architect/data-and-formulas.md +186 -0
- package/dist/skills/excel-architect/generator.md +272 -0
- package/dist/skills/excel-architect/macos/scripts/add-data-validation.applescript +242 -0
- package/dist/skills/excel-architect/macos/scripts/append-rows.applescript +310 -0
- package/dist/skills/excel-architect/macos/scripts/apply-conditional-format.applescript +565 -0
- package/dist/skills/excel-architect/macos/scripts/autofit-columns.applescript +79 -0
- package/dist/skills/excel-architect/macos/scripts/benchmark.sh +135 -0
- package/dist/skills/excel-architect/macos/scripts/check-compile.sh +30 -0
- package/dist/skills/excel-architect/macos/scripts/clear-range.applescript +152 -0
- package/dist/skills/excel-architect/macos/scripts/copy-paste.applescript +179 -0
- package/dist/skills/excel-architect/macos/scripts/create-chart.applescript +531 -0
- package/dist/skills/excel-architect/macos/scripts/create-pivot.applescript +443 -0
- package/dist/skills/excel-architect/macos/scripts/create-sheets.applescript +264 -0
- package/dist/skills/excel-architect/macos/scripts/create-workbook.applescript +92 -0
- package/dist/skills/excel-architect/macos/scripts/delete-chart.applescript +105 -0
- package/dist/skills/excel-architect/macos/scripts/delete-sheet.applescript +127 -0
- package/dist/skills/excel-architect/macos/scripts/filter-data.applescript +213 -0
- package/dist/skills/excel-architect/macos/scripts/find-replace.applescript +238 -0
- package/dist/skills/excel-architect/macos/scripts/format-range.applescript +531 -0
- package/dist/skills/excel-architect/macos/scripts/freeze-panes.applescript +133 -0
- package/dist/skills/excel-architect/macos/scripts/get-current-file.applescript +24 -0
- package/dist/skills/excel-architect/macos/scripts/get-sheet-dimensions.applescript +115 -0
- package/dist/skills/excel-architect/macos/scripts/health-check.applescript +704 -0
- package/dist/skills/excel-architect/macos/scripts/list-open-workbooks.applescript +80 -0
- package/dist/skills/excel-architect/macos/scripts/maximize-window.applescript +47 -0
- package/dist/skills/excel-architect/macos/scripts/merge-cells.applescript +227 -0
- package/dist/skills/excel-architect/macos/scripts/open-workbook.applescript +139 -0
- package/dist/skills/excel-architect/macos/scripts/read-range.applescript +267 -0
- package/dist/skills/excel-architect/macos/scripts/rename-sheet.applescript +231 -0
- package/dist/skills/excel-architect/macos/scripts/select-sheet.applescript +133 -0
- package/dist/skills/excel-architect/macos/scripts/set-tab-color.applescript +109 -0
- package/dist/skills/excel-architect/macos/scripts/sort-data.applescript +136 -0
- package/dist/skills/excel-architect/macos/scripts/undo.applescript +59 -0
- package/dist/skills/excel-architect/macos/scripts/workbook-lifecycle.applescript +149 -0
- package/dist/skills/excel-architect/macos/scripts/write-formula.applescript +225 -0
- package/dist/skills/excel-architect/macos/scripts/write-range.applescript +351 -0
- package/dist/skills/excel-architect/reference/api/advanced.md +381 -0
- package/dist/skills/excel-architect/reference/api/basic.md +747 -0
- package/dist/skills/excel-architect/reference/guides.md +348 -0
- package/dist/skills/excel-architect/reference/repair.md +174 -0
- package/dist/skills/excel-architect/reference/troubleshooting.md +46 -0
- package/dist/skills/excel-architect/scripting.md +266 -0
- package/dist/skills/excel-architect/styling-and-features.md +433 -0
- package/dist/skills/excel-architect/windows/api/composites.md +337 -0
- package/dist/skills/excel-architect/windows/api/scripting.md +139 -0
- package/dist/skills/excel-architect/windows/examples/level-1-workflows.md +485 -0
- package/dist/skills/excel-architect/windows/examples/level-2-advanced.md +690 -0
- package/dist/skills/excel-architect/windows/examples/level-3-scripting.md +337 -0
- package/dist/skills/github/SKILL.md +446 -0
- package/dist/skills/github/recipes/add-comment.md +85 -0
- package/dist/skills/github/recipes/check-pr-status.md +122 -0
- package/dist/skills/github/recipes/compare-branches.md +79 -0
- package/dist/skills/github/recipes/create-issue.md +103 -0
- package/dist/skills/github/recipes/create-pr.md +97 -0
- package/dist/skills/github/recipes/get-file-contents.md +76 -0
- package/dist/skills/github/recipes/get-last-commit.md +128 -0
- package/dist/skills/github/recipes/list-my-open-prs.md +105 -0
- package/dist/skills/github/recipes/list-recent-commits.md +84 -0
- package/dist/skills/github/recipes/search-issues.md +115 -0
- package/dist/skills/google-workspace/SKILL.md +217 -0
- package/dist/skills/google-workspace/services/calendar.md +311 -0
- package/dist/skills/google-workspace/services/docs.md +426 -0
- package/dist/skills/google-workspace/services/drive.md +504 -0
- package/dist/skills/google-workspace/services/gmail.md +466 -0
- package/dist/skills/google-workspace/services/sheets.md +370 -0
- package/dist/skills/internal-comms/SKILL.md +35 -0
- package/dist/skills/internal-comms/examples/3p-updates.md +47 -0
- package/dist/skills/internal-comms/examples/company-newsletter.md +65 -0
- package/dist/skills/internal-comms/examples/faq-answers.md +30 -0
- package/dist/skills/internal-comms/examples/general-comms.md +15 -0
- package/dist/skills/jira/SKILL.md +397 -0
- package/dist/skills/jira/recipes/add-comment.md +123 -0
- package/dist/skills/jira/recipes/assign-issue.md +157 -0
- package/dist/skills/jira/recipes/create-issue.md +274 -0
- package/dist/skills/jira/recipes/get-issue-details.md +154 -0
- package/dist/skills/jira/recipes/list-projects.md +151 -0
- package/dist/skills/jira/recipes/my-issues.md +180 -0
- package/dist/skills/jira/recipes/search-issues.md +215 -0
- package/dist/skills/jira/recipes/transition-issue.md +154 -0
- package/dist/skills/jira/recipes/troubleshooting.md +387 -0
- package/dist/skills/knowledge-base/SKILL.md +289 -0
- package/dist/skills/media-tools/SKILL.md +204 -0
- package/dist/skills/media-tools/references/encode-runbook.md +24 -0
- package/dist/skills/media-tools/references/resolve-binaries.md +88 -0
- package/dist/skills/media-tools/scripts/macos/ff-launch.sh +22 -0
- package/dist/skills/media-tools/scripts/macos/ff-poll.sh +10 -0
- package/dist/skills/media-tools/scripts/windows/ff-launch.ps1 +34 -0
- package/dist/skills/media-tools/scripts/windows/ff-poll.ps1 +20 -0
- package/dist/skills/office-download/SKILL.md +161 -0
- package/dist/skills/outlook-365/SKILL.macos.md +331 -0
- package/dist/skills/outlook-365/SKILL.md +171 -0
- package/dist/skills/outlook-365/SKILL.windows.md +124 -0
- package/dist/skills/outlook-365/api/bulk-email-operations.md +178 -0
- package/dist/skills/outlook-365/api/check-availability.md +87 -0
- package/dist/skills/outlook-365/api/create-inbox-rule.md +182 -0
- package/dist/skills/outlook-365/api/download-attachments.md +149 -0
- package/dist/skills/outlook-365/api/find-and-email-contact.md +185 -0
- package/dist/skills/outlook-365/api/manage-calendar-events.md +189 -0
- package/dist/skills/outlook-365/api/organize-with-folders.md +178 -0
- package/dist/skills/outlook-365/api/reply-to-conversation.md +68 -0
- package/dist/skills/outlook-365/api/schedule-meeting.md +73 -0
- package/dist/skills/outlook-365/api/search-and-read-email.md +93 -0
- package/dist/skills/outlook-365/api/send-email-with-attachments.md +94 -0
- package/dist/skills/outlook-365/api/send-email.md +396 -0
- package/dist/skills/outlook-365/api/set-out-of-office.md +196 -0
- package/dist/skills/outlook-365/macos/scripts/bulk-operations.applescript +429 -0
- package/dist/skills/outlook-365/macos/scripts/calendar.applescript +642 -0
- package/dist/skills/outlook-365/macos/scripts/contacts.applescript +635 -0
- package/dist/skills/outlook-365/macos/scripts/helpers.applescript +227 -0
- package/dist/skills/outlook-365/macos/scripts/read-emails.applescript +299 -0
- package/dist/skills/outlook-365/macos/scripts/search-emails.applescript +339 -0
- package/dist/skills/outlook-365/macos/scripts/send-email.applescript +245 -0
- package/dist/skills/outlook-365/uia/BASIC_OPERATIONS.md +278 -0
- package/dist/skills/outlook-365/uia/CALENDAR_OPERATIONS.md +386 -0
- package/dist/skills/outlook-365/uia/COMPOSE_EMAIL.md +426 -0
- package/dist/skills/outlook-365/uia/README.md +75 -0
- package/dist/skills/outlook-365/windows/com/bulk-operations.ps1 +241 -0
- package/dist/skills/outlook-365/windows/com/calendar.ps1 +227 -0
- package/dist/skills/outlook-365/windows/com/contacts.ps1 +270 -0
- package/dist/skills/outlook-365/windows/com/helpers.ps1 +158 -0
- package/dist/skills/outlook-365/windows/com/read-emails.ps1 +115 -0
- package/dist/skills/outlook-365/windows/com/search-emails.ps1 +141 -0
- package/dist/skills/outlook-365/windows/com/send-email.ps1 +121 -0
- package/dist/skills/pdf-architect/SKILL.md +640 -0
- package/dist/skills/powerpoint-architect/SKILL.macos.md +271 -0
- package/dist/skills/powerpoint-architect/SKILL.md +853 -0
- package/dist/skills/powerpoint-architect/SKILL.windows.md +458 -0
- package/dist/skills/powerpoint-architect/custom_themes.md +141 -0
- package/dist/skills/powerpoint-architect/editing-guide.md +424 -0
- package/dist/skills/powerpoint-architect/generator-reference.md +668 -0
- package/dist/skills/powerpoint-architect/images-guide.md +207 -0
- package/dist/skills/powerpoint-architect/issue-fix-mapping.md +768 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-html-to-slide.applescript +389 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-slide.applescript +255 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-speaker-notes.applescript +132 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-text.applescript +245 -0
- package/dist/skills/powerpoint-architect/macos/scripts/apply-slide-layout.applescript +80 -0
- package/dist/skills/powerpoint-architect/macos/scripts/apply-theme.applescript +122 -0
- package/dist/skills/powerpoint-architect/macos/scripts/autofit-placeholders.applescript +62 -0
- package/dist/skills/powerpoint-architect/macos/scripts/close-presentation.applescript +24 -0
- package/dist/skills/powerpoint-architect/macos/scripts/copy-slides.applescript +303 -0
- package/dist/skills/powerpoint-architect/macos/scripts/create-chart-with-data.applescript +305 -0
- package/dist/skills/powerpoint-architect/macos/scripts/create-with-theme.applescript +56 -0
- package/dist/skills/powerpoint-architect/macos/scripts/delete-slides.applescript +137 -0
- package/dist/skills/powerpoint-architect/macos/scripts/export-presentation.applescript +100 -0
- package/dist/skills/powerpoint-architect/macos/scripts/extract-slide-data.applescript +138 -0
- package/dist/skills/powerpoint-architect/macos/scripts/format-shape.applescript +192 -0
- package/dist/skills/powerpoint-architect/macos/scripts/format-slide-content.applescript +336 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-current-slide-number.applescript +38 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-file-path.applescript +94 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-layout-elements.applescript +141 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-layouts.applescript +58 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-opened-files.applescript +50 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-presentation-info.applescript +150 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-recent-files.applescript +68 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-slide-count.applescript +37 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-slide-info.applescript +105 -0
- package/dist/skills/powerpoint-architect/macos/scripts/health-check.applescript +690 -0
- package/dist/skills/powerpoint-architect/macos/scripts/insert-shape.applescript +188 -0
- package/dist/skills/powerpoint-architect/macos/scripts/insert-table.applescript +112 -0
- package/dist/skills/powerpoint-architect/macos/scripts/insert-text-box.applescript +225 -0
- package/dist/skills/powerpoint-architect/macos/scripts/manage-image.applescript +486 -0
- package/dist/skills/powerpoint-architect/macos/scripts/maximize-window.applescript +48 -0
- package/dist/skills/powerpoint-architect/macos/scripts/navigate-to-slide.applescript +84 -0
- package/dist/skills/powerpoint-architect/macos/scripts/open-presentation.applescript +38 -0
- package/dist/skills/powerpoint-architect/macos/scripts/reorder-slides.applescript +106 -0
- package/dist/skills/powerpoint-architect/macos/scripts/replace-text.applescript +193 -0
- package/dist/skills/powerpoint-architect/macos/scripts/save-presentation.applescript +54 -0
- package/dist/skills/powerpoint-architect/macos/scripts/set-animation.applescript +203 -0
- package/dist/skills/powerpoint-architect/macos/scripts/set-transition.applescript +130 -0
- package/dist/skills/powerpoint-architect/visual-styling-guide.md +206 -0
- package/dist/skills/powerpoint-architect/windows/api/advanced.md +317 -0
- package/dist/skills/powerpoint-architect/windows/api/basic.md +392 -0
- package/dist/skills/powerpoint-architect/windows/examples/10-slide-presentation.md +140 -0
- package/dist/skills/powerpoint-architect/windows/examples/custom-theme-workflow.md +219 -0
- package/dist/skills/powerpoint-architect/windows/examples/level-1-workflows.md +531 -0
- package/dist/skills/powerpoint-architect/windows/examples/level-2-scripting.md +239 -0
- package/dist/skills/powerpoint-architect/windows/scripts/create-with-theme.ps1 +81 -0
- package/dist/skills/project-task-list/SKILL.md +174 -0
- package/dist/skills/slack-operation/SKILL.md +97 -0
- package/dist/skills/slack-operation/api/advanced-api/GUIDE.md +277 -0
- package/dist/skills/slack-operation/api/search-and-read/EXAMPLE.md +75 -0
- package/dist/skills/slack-operation/api/search-and-read/GUIDE.md +108 -0
- package/dist/skills/slack-operation/api/send-message/EXAMPLE.md +112 -0
- package/dist/skills/slack-operation/api/send-message/GUIDE.md +63 -0
- package/dist/skills/slack-operation/api/share-files/EXAMPLE.md +94 -0
- package/dist/skills/slack-operation/api/share-files/GUIDE.md +63 -0
- package/dist/skills/slack-operation/ui/desktop-automation/GUIDE.md +55 -0
- package/dist/skills/system-diagnostics/SKILL.md +263 -0
- package/dist/skills/teams-operation/SKILL.md +79 -0
- package/dist/skills/teams-operation/api/advanced-api/GUIDE.md +234 -0
- package/dist/skills/teams-operation/api/meetings/EXAMPLE.md +63 -0
- package/dist/skills/teams-operation/api/meetings/GUIDE.md +52 -0
- package/dist/skills/teams-operation/api/search-and-read/EXAMPLE.md +72 -0
- package/dist/skills/teams-operation/api/search-and-read/GUIDE.md +54 -0
- package/dist/skills/teams-operation/api/send-message/EXAMPLE.md +92 -0
- package/dist/skills/teams-operation/api/send-message/GUIDE.md +60 -0
- package/dist/skills/teams-operation/ui/desktop-automation/GUIDE.md +66 -0
- package/dist/skills/transcribe-media/SKILL.md +142 -0
- package/dist/skills/uipath-integrations/SKILL.md +370 -0
- package/dist/skills/uipath-integrations/reference/connectors.md +331 -0
- package/dist/skills/uipath-integrations/reference/endpoints.md +220 -0
- package/dist/skills/uipath-integrations/reference/errors.md +211 -0
- package/dist/skills/uipath-integrations/reference/metadata.md +317 -0
- package/dist/skills/uipath-integrations/reference/operations.md +297 -0
- package/dist/skills/uipath-orchestrator/SKILL.md +312 -0
- package/dist/skills/uipath-orchestrator/recipes/assets.md +282 -0
- package/dist/skills/uipath-orchestrator/recipes/audit-logs.md +215 -0
- package/dist/skills/uipath-orchestrator/recipes/buckets.md +205 -0
- package/dist/skills/uipath-orchestrator/recipes/jobs.md +286 -0
- package/dist/skills/uipath-orchestrator/recipes/list-folders.md +207 -0
- package/dist/skills/uipath-orchestrator/recipes/queue-items.md +292 -0
- package/dist/skills/uipath-orchestrator/recipes/queues.md +232 -0
- package/dist/skills/uipath-orchestrator/recipes/releases.md +212 -0
- package/dist/skills/uipath-orchestrator/recipes/robots-sessions.md +274 -0
- package/dist/skills/uipath-orchestrator/recipes/schedules.md +280 -0
- package/dist/skills/uipath-orchestrator/reference/endpoints.md +85 -0
- package/dist/skills/uipath-orchestrator/reference/schemas.md +153 -0
- package/dist/skills/uipath-taskautomation/SKILL.md +310 -0
- package/dist/skills/uipath-taskautomation/assets/CodedWorkflow.template.cs +98 -0
- package/dist/skills/uipath-taskautomation/assets/ExampleWorkflow.cs +146 -0
- package/dist/skills/uipath-taskautomation/references/action-activity-map.json +32 -0
- package/dist/skills/uipath-taskautomation/references/action-activity-map.md +44 -0
- package/dist/skills/uipath-taskautomation/references/app-profiles.md +63 -0
- package/dist/skills/uipath-taskautomation/references/automation-spec.md +88 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/before-after-hooks-template.md +115 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/codedworkflow-template.md +186 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/helper-utility-template.md +22 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/json-template.md +91 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/testcase-template.md +92 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/cli-reference.md +249 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/codedworkflow-reference.md +275 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/coding-guidelines.md +229 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/inspect-package-guide.md +81 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/integration-service-guide.md +507 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/operations-guide.md +410 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/third-party-packages-guide.md +67 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/data-manipulation-guide.md +110 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/environment-setup.md +194 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/error-handling-guide.md +195 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/powershell-interop-guide.md +57 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/project-structure-guide.md +114 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/project-structure.md +126 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/uia-elements-interaction-guide.md +109 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/validation-guide.md +147 -0
- package/dist/skills/uipath-taskautomation/references/coded-workflow-authoring.md +219 -0
- package/dist/skills/uipath-taskautomation/references/profiling-output.md +80 -0
- package/dist/skills/uipath-taskautomation/references/reliability-guide.md +83 -0
- package/dist/skills/uipath-taskautomation/references/task-automation-cheatsheet.md +272 -0
- package/dist/skills/uipath-taskautomation/references/template-preflight.md +17 -0
- package/dist/skills/uipath-workflow-documenter/SKILL.md +430 -0
- package/dist/skills/uipath-workflow-documenter/layouts/pdd-template.md +265 -0
- package/dist/skills/uipath-workflow-documenter/routines/from-orchestrator.md +11 -0
- package/dist/skills/uipath-workflow-documenter/routines/from-workflow.md +11 -0
- package/dist/skills/word-architect/SKILL.macos.md +147 -0
- package/dist/skills/word-architect/SKILL.md +502 -0
- package/dist/skills/word-architect/SKILL.windows.md +55 -0
- package/dist/skills/word-architect/api/advanced.md +522 -0
- package/dist/skills/word-architect/api/basic.md +378 -0
- package/dist/skills/word-architect/api/expert.md +302 -0
- package/dist/skills/word-architect/generation.md +308 -0
- package/dist/skills/word-architect/layouts/01-professional.md +168 -0
- package/dist/skills/word-architect/layouts/02-educational-kids.md +354 -0
- package/dist/skills/word-architect/layouts/03-academic.md +83 -0
- package/dist/skills/word-architect/layouts/04-creative.md +242 -0
- package/dist/skills/word-architect/layouts/05-operational.md +94 -0
- package/dist/skills/word-architect/macos/scripts/apply-heading-style.applescript +215 -0
- package/dist/skills/word-architect/macos/scripts/apply-style.applescript +272 -0
- package/dist/skills/word-architect/macos/scripts/autofit-tables.applescript +53 -0
- package/dist/skills/word-architect/macos/scripts/close-document.applescript +287 -0
- package/dist/skills/word-architect/macos/scripts/create-chart-with-data.applescript +379 -0
- package/dist/skills/word-architect/macos/scripts/create-chart.applescript +191 -0
- package/dist/skills/word-architect/macos/scripts/delete-selection.applescript +223 -0
- package/dist/skills/word-architect/macos/scripts/export-document.applescript +167 -0
- package/dist/skills/word-architect/macos/scripts/extract-table.applescript +168 -0
- package/dist/skills/word-architect/macos/scripts/find-by-style.applescript +173 -0
- package/dist/skills/word-architect/macos/scripts/find-text.applescript +199 -0
- package/dist/skills/word-architect/macos/scripts/format-table.applescript +234 -0
- package/dist/skills/word-architect/macos/scripts/format-text.applescript +431 -0
- package/dist/skills/word-architect/macos/scripts/get-document-properties.applescript +95 -0
- package/dist/skills/word-architect/macos/scripts/get-document-structure.applescript +371 -0
- package/dist/skills/word-architect/macos/scripts/get-header-footer-text.applescript +106 -0
- package/dist/skills/word-architect/macos/scripts/get-images.applescript +166 -0
- package/dist/skills/word-architect/macos/scripts/get-opened-files.applescript +103 -0
- package/dist/skills/word-architect/macos/scripts/get-paragraph-bounds.applescript +133 -0
- package/dist/skills/word-architect/macos/scripts/get-paragraph-format.applescript +134 -0
- package/dist/skills/word-architect/macos/scripts/get-recent-files.applescript +82 -0
- package/dist/skills/word-architect/macos/scripts/get-styled-text.applescript +256 -0
- package/dist/skills/word-architect/macos/scripts/get-tables.applescript +126 -0
- package/dist/skills/word-architect/macos/scripts/get-text-formatting.applescript +224 -0
- package/dist/skills/word-architect/macos/scripts/get-text.applescript +383 -0
- package/dist/skills/word-architect/macos/scripts/get-theme-colors.applescript +123 -0
- package/dist/skills/word-architect/macos/scripts/health-check.applescript +606 -0
- package/dist/skills/word-architect/macos/scripts/insert-cover-page.applescript +77 -0
- package/dist/skills/word-architect/macos/scripts/insert-header-footer.applescript +87 -0
- package/dist/skills/word-architect/macos/scripts/insert-horizontal-line.applescript +112 -0
- package/dist/skills/word-architect/macos/scripts/insert-html.applescript +440 -0
- package/dist/skills/word-architect/macos/scripts/insert-hyperlink.applescript +191 -0
- package/dist/skills/word-architect/macos/scripts/insert-image.applescript +320 -0
- package/dist/skills/word-architect/macos/scripts/insert-list.applescript +317 -0
- package/dist/skills/word-architect/macos/scripts/insert-pagebreak.applescript +181 -0
- package/dist/skills/word-architect/macos/scripts/insert-smartart.applescript +104 -0
- package/dist/skills/word-architect/macos/scripts/insert-table.applescript +238 -0
- package/dist/skills/word-architect/macos/scripts/insert-text.applescript +677 -0
- package/dist/skills/word-architect/macos/scripts/insert-textbox.applescript +261 -0
- package/dist/skills/word-architect/macos/scripts/maximize-window.applescript +67 -0
- package/dist/skills/word-architect/macos/scripts/normalize-formatting.applescript +56 -0
- package/dist/skills/word-architect/macos/scripts/open-document.applescript +222 -0
- package/dist/skills/word-architect/macos/scripts/replace-text.applescript +390 -0
- package/dist/skills/word-architect/macos/scripts/save-document.applescript +230 -0
- package/dist/skills/word-architect/macos/scripts/select-range.applescript +142 -0
- package/dist/skills/word-architect/macos/scripts/set-document-properties.applescript +195 -0
- package/dist/skills/word-architect/macos/scripts/set-page-layout.applescript +273 -0
- package/dist/skills/word-architect/macos/scripts/set-theme-colors.applescript +264 -0
- package/dist/skills/word-architect/macos/scripts/undo-redo.applescript +61 -0
- package/dist/skills/word-architect/macos/scripts/update-toc.applescript +112 -0
- package/dist/skills/word-architect/reference/formatting.md +119 -0
- package/dist/skills/word-architect/reference/html-layouts/01-executive-summary-box.md +36 -0
- package/dist/skills/word-architect/reference/html-layouts/02-kpi-summary-table.md +68 -0
- package/dist/skills/word-architect/reference/html-layouts/03-comparison-table.md +63 -0
- package/dist/skills/word-architect/reference/html-layouts/04-pros-cons-table.md +86 -0
- package/dist/skills/word-architect/reference/html-layouts/05-timeline-table.md +114 -0
- package/dist/skills/word-architect/reference/html-layouts/06-raci-matrix.md +95 -0
- package/dist/skills/word-architect/reference/html-layouts/07-data-table-alternating.md +84 -0
- package/dist/skills/word-architect/reference/html-layouts/08-callout-box.md +102 -0
- package/dist/skills/word-architect/reference/html-layouts/09-vertical-milestone.md +100 -0
- package/dist/skills/word-architect/reference/quality-assurance.md +102 -0
- package/dist/skills/word-architect/reference/tables.md +62 -0
- package/dist/skills/word-architect/reference/tracked-changes.md +34 -0
- package/dist/skills/word-architect/reference/uia-fallback.md +231 -0
- package/dist/skills/word-architect/reference/visual-elements.md +82 -0
- package/dist/skills/word-architect/windows/scripts/apply-heading-style.ps1 +190 -0
- package/dist/skills/word-architect/windows/scripts/autofit-tables.ps1 +64 -0
- package/dist/skills/word-architect/windows/scripts/create-chart-with-data.ps1 +133 -0
- package/dist/skills/word-architect/windows/scripts/create-chart.ps1 +73 -0
- package/dist/skills/word-architect/windows/scripts/export-document.ps1 +86 -0
- package/dist/skills/word-architect/windows/scripts/get-current-file.ps1 +27 -0
- package/dist/skills/word-architect/windows/scripts/insert-cover-page.ps1 +79 -0
- package/dist/skills/word-architect/windows/scripts/insert-horizontal-line.ps1 +74 -0
- package/dist/skills/word-architect/windows/scripts/insert-image.ps1 +98 -0
- package/dist/skills/word-architect/windows/scripts/insert-smartart.ps1 +118 -0
- package/dist/skills/word-architect/windows/scripts/insert-text-box.ps1 +90 -0
- package/dist/skills/word-architect/windows/scripts/normalize-formatting.ps1 +63 -0
- package/package.json +5 -4
|
@@ -0,0 +1,308 @@
|
|
|
1
|
+
# Document Generation Reference
|
|
2
|
+
|
|
3
|
+
**For the CREATE path only.** The workflow is in SKILL.md — this file covers block types, API calls, themes, and options.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Using a Template File
|
|
8
|
+
|
|
9
|
+
**When the user provides a .docx template**, pass its path as `templatePath` in options instead of `theme`. The generator will parse the template and automatically extract its fonts, colors, heading sizes, spacing, page margins, page size, orientation, and headers/footers.
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
"options": {
|
|
13
|
+
"title": "My Report",
|
|
14
|
+
"templatePath": "/path/to/template.docx",
|
|
15
|
+
"outputPath": "/path/to/output.docx"
|
|
16
|
+
}
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
- `templatePath` **overrides** `theme` — do NOT set both.
|
|
20
|
+
- User-specified options (margins, headerFooter, etc.) take priority over template-extracted values.
|
|
21
|
+
- Works with `/doc-gen/generate` (single call) and `/doc-gen/start` (multi-turn) equally.
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## Generator API
|
|
26
|
+
|
|
27
|
+
Use `/doc-gen/generate` for documents with ≤25 content blocks. For larger documents, **always** use the multi-turn flow below — it avoids token limits and produces better results. Works on both Windows and macOS.
|
|
28
|
+
|
|
29
|
+
### Multi-Turn Generation (large documents only)
|
|
30
|
+
|
|
31
|
+
**Call 1 (`/doc-gen/start`): Cover + TOC + first section** (TOC is mandatory for multi-section docs)
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
ExecuteSkillApi:
|
|
35
|
+
endpoint: "/doc-gen/start"
|
|
36
|
+
body: {
|
|
37
|
+
"options": {
|
|
38
|
+
"title": "Document Title", "author": "Author", "theme": "consulting",
|
|
39
|
+
"outputPath": "/path/to/output.docx", "pageSize": "LETTER",
|
|
40
|
+
"headerFooter": {
|
|
41
|
+
"header": { "text": "Header", "alignment": "right" },
|
|
42
|
+
"footer": { "text": "Footer", "alignment": "center", "includePageNumber": true }
|
|
43
|
+
}
|
|
44
|
+
},
|
|
45
|
+
"content": [
|
|
46
|
+
{ "type": "coverPage", "title": "...", "subtitle": "...", "author": "...", "date": "..." },
|
|
47
|
+
{ "type": "toc", "maxLevel": 3 },
|
|
48
|
+
{ "type": "pageBreak" },
|
|
49
|
+
{ "type": "heading", "level": 1, "text": "First Section", "bookmarkId": "section1" },
|
|
50
|
+
{ "type": "paragraph", "text": "Opening paragraph with real data..." }
|
|
51
|
+
]
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
**Calls 2-3 (`/doc-gen/add-content`): 3-4 H1 sections per call**
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
ExecuteSkillApi:
|
|
59
|
+
endpoint: "/doc-gen/add-content"
|
|
60
|
+
body: {
|
|
61
|
+
"content": [
|
|
62
|
+
{ "type": "heading", "level": 1, "text": "Next Section", "bookmarkId": "section2" },
|
|
63
|
+
{ "type": "paragraph", "text": "..." },
|
|
64
|
+
{ "type": "table", "headers": [...], "rows": [...], "caption": "Source: ..." },
|
|
65
|
+
{ "type": "chart", "chartType": "column", "title": "...", "categories": [...], "series": [...] }
|
|
66
|
+
]
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
**Final call (`/doc-gen/finish`): Generate the file**
|
|
71
|
+
|
|
72
|
+
```
|
|
73
|
+
ExecuteSkillApi:
|
|
74
|
+
endpoint: "/doc-gen/finish"
|
|
75
|
+
body: {}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
**After `/doc-gen/finish` succeeds — verify the output:**
|
|
79
|
+
|
|
80
|
+
On Windows, verification runs entirely off-screen: `/word/open-attach` defaults to `visible: false`, so do not pass `visible` here — the user asked for a document, not to watch it being checked. On macOS the flag does not exist and Word will appear, so do not tell the user otherwise.
|
|
81
|
+
|
|
82
|
+
1. Open via API: `/word/open-attach` with the same `outputPath`
|
|
83
|
+
2. **Update the TOC** — the generator writes an unfilled TOC field:
|
|
84
|
+
- `/word/update/toc` with `{"action":"update"}` (macOS defaults to `insert`, which only replaces `[TOC]` placeholders)
|
|
85
|
+
3. Read structure: `/word/get/document-structure` to verify headings, sections, page count
|
|
86
|
+
4. Spot-check content: `/word/get/text` on key sections to confirm data made it in
|
|
87
|
+
5. Fix blocking issues with `/word/*` API endpoints. Follow the review severity and retry budget in `reference/quality-assurance.md`; cosmetic findings do not justify regeneration.
|
|
88
|
+
6. **Run health check** — **macOS:** `/word/get-status`. **Windows:** manual checks (see `reference/quality-assurance.md`). Fix blocking issues within the convergence budget.
|
|
89
|
+
7. **`/word/save`** — always, even when steps 3–6 found nothing to fix. Updating the TOC in step 2 changed the document, and on macOS the next step closes without saving, so skipping this hands the user back an unfilled TOC.
|
|
90
|
+
8. `/word/close` — releases the file so the user can move or rename it
|
|
91
|
+
9. Report to user: summarize what was generated (page count, sections, key findings)
|
|
92
|
+
|
|
93
|
+
If `/word/open-attach` fails, retry once. In an off-screen/background workflow, preserve the generated artifact and report the verification limitation instead of regenerating or opening Word visibly. Use UIA only when the user explicitly permits visible interaction.
|
|
94
|
+
|
|
95
|
+
Keep each call under ~15 content blocks. For small documents (<10 blocks), use single-call `/doc-gen/generate`.
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
## Standard Document Structure
|
|
100
|
+
|
|
101
|
+
Every comprehensive document MUST start with these blocks **in this order**:
|
|
102
|
+
|
|
103
|
+
1. `coverPage` — always first
|
|
104
|
+
2. `toc` — **REQUIRED for all documents with 3+ sections.** Only omit for creative/kids layouts or very short docs (<3 headings). Use `{ "type": "toc", "maxLevel": 3 }`.
|
|
105
|
+
3. `pageBreak` — after TOC
|
|
106
|
+
4. Content sections starting with `heading` level 1
|
|
107
|
+
|
|
108
|
+
## Page Estimation
|
|
109
|
+
|
|
110
|
+
Use this to plan how many blocks fit within the user's target page count. The generator auto-inserts a page break before every H1 heading — each section starts on a new page and its content fills from there.
|
|
111
|
+
|
|
112
|
+
**Fixed costs:** coverPage = 1 page, toc = 1 page.
|
|
113
|
+
|
|
114
|
+
**Block costs (consulting/modern themes, LETTER):**
|
|
115
|
+
|
|
116
|
+
| Block | Page cost |
|
|
117
|
+
|-------|-----------|
|
|
118
|
+
| paragraph (3-5 sentences) | 0.10 - 0.15 |
|
|
119
|
+
| paragraph (6-8 sentences) | 0.15 - 0.25 |
|
|
120
|
+
| table (≤6 rows) | 0.25 - 0.35 |
|
|
121
|
+
| table (7-12 rows) | 0.40 - 0.55 |
|
|
122
|
+
| chart (default 6"×3.5") | 0.45 - 0.55 |
|
|
123
|
+
| callout | 0.15 - 0.25 |
|
|
124
|
+
| list (5-8 items) | 0.20 - 0.30 |
|
|
125
|
+
| H2 heading | 0.05 |
|
|
126
|
+
| image (default 6"×4") | 0.50 - 0.60 |
|
|
127
|
+
| diagram | 0.45 - 0.60 |
|
|
128
|
+
|
|
129
|
+
> Academic theme: multiply by 1.6×. Playful/nature: multiply by 1.1×.
|
|
130
|
+
|
|
131
|
+
**Formula:**
|
|
132
|
+
|
|
133
|
+
```
|
|
134
|
+
fixed_pages = 2 (cover + TOC)
|
|
135
|
+
pages_per_section = (target - fixed_pages) / number_of_H1_sections
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
`pages_per_section` is the TOTAL space each section fills — including its starting page. If > 1.0, the section must spill onto additional pages. Sum block costs per section to reach `pages_per_section`. See SKILL.md "Page Budget" section for detailed rules.
|
|
139
|
+
|
|
140
|
+
---
|
|
141
|
+
|
|
142
|
+
## Content Block Types
|
|
143
|
+
|
|
144
|
+
| Type | Key Fields | Notes |
|
|
145
|
+
| ---------------- | ----------------------------------------------------------- | ----------------------------------------- |
|
|
146
|
+
| `coverPage` | title, subtitle, author, date | First page with branding |
|
|
147
|
+
| `toc` | maxLevel (1-3) | **Include for all docs with 3+ sections.** Filled by `/word/update/toc` (verification step 2). |
|
|
148
|
+
| `heading` | level (1-3), text, bookmarkId?, color?, bgColor?, italic? | color/bgColor override theme (hex). bgColor = pastel background band. italic = bold+italic heading. |
|
|
149
|
+
| `paragraph` | text (string or TextRun[]) | See text runs below |
|
|
150
|
+
| `table` | headers[], rows[][], caption?, headerBgColor?, headerTextColor?, altRowColor?, conditionalFormatting? | Color overrides for per-section theming. `conditionalFormatting: true` auto-colors cells (Strong=green, Moderate=orange, Weak=gray, +%=green, -%=red, star ratings, scores) |
|
|
151
|
+
| `list` | style (bullet/numbered), items[] | |
|
|
152
|
+
| `chart` | chartType, categories[], series[], title?, caption? | Rendered as embedded PNG |
|
|
153
|
+
| `callout` | style, title, text, borderColor?, bgColor? | Color overrides for per-section theming |
|
|
154
|
+
| `image` | image.path, image.width, image.altText?, caption? | |
|
|
155
|
+
| `diagram` | diagram.code, diagram.caption?, title?, width?, height?, alignment? | Diagram rendered as embedded PNG |
|
|
156
|
+
| `textBox` | text, width?, height?, borderColorHex?, backgroundColorHex? | |
|
|
157
|
+
| `pageBreak` | | |
|
|
158
|
+
| `horizontalLine` | | |
|
|
159
|
+
|
|
160
|
+
### Text Runs (Inline Formatting)
|
|
161
|
+
|
|
162
|
+
```json
|
|
163
|
+
{
|
|
164
|
+
"type": "paragraph",
|
|
165
|
+
"text": [
|
|
166
|
+
{ "text": "Normal text " },
|
|
167
|
+
{ "text": "bold", "bold": true },
|
|
168
|
+
{ "text": " and " },
|
|
169
|
+
{ "text": "colored", "color": "2F5496", "italic": true }
|
|
170
|
+
]
|
|
171
|
+
}
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
**TextRun fields:** `text`, `bold`, `italic`, `underline`, `color` (hex), `font`, `size`, `footnote`, `anchor`
|
|
175
|
+
|
|
176
|
+
### Footnotes
|
|
177
|
+
|
|
178
|
+
**IMPORTANT: Footnotes ONLY work inside TextRun arrays. NEVER put footnote in plain text strings.**
|
|
179
|
+
|
|
180
|
+
```json
|
|
181
|
+
{
|
|
182
|
+
"type": "paragraph",
|
|
183
|
+
"text": [
|
|
184
|
+
{ "text": "Revenue grew 15%", "footnote": "Source: Annual Report 2024" },
|
|
185
|
+
{ "text": " using adjusted metrics." }
|
|
186
|
+
]
|
|
187
|
+
}
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
### Bookmarks and Internal Hyperlinks
|
|
191
|
+
|
|
192
|
+
```json
|
|
193
|
+
{ "type": "heading", "level": 1, "text": "Chapter 1", "bookmarkId": "chapter1" }
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
```json
|
|
197
|
+
{
|
|
198
|
+
"type": "paragraph",
|
|
199
|
+
"text": [
|
|
200
|
+
{ "text": "See " },
|
|
201
|
+
{ "text": "Chapter 1", "anchor": "chapter1", "color": "2F5496" }
|
|
202
|
+
]
|
|
203
|
+
}
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
### Charts
|
|
207
|
+
|
|
208
|
+
**Chart types:** `column`, `bar`, `line`, `pie`, `doughnut`, `area`, `radar`. See [reference/visual-elements.md](reference/visual-elements.md) for design guidance and when-to-use rules per template.
|
|
209
|
+
|
|
210
|
+
```json
|
|
211
|
+
{
|
|
212
|
+
"type": "chart",
|
|
213
|
+
"chartType": "column",
|
|
214
|
+
"title": "Revenue by Region",
|
|
215
|
+
"categories": ["APAC", "EMEA"],
|
|
216
|
+
"series": [{ "name": "Revenue ($M)", "values": [3.5, 2.8] }],
|
|
217
|
+
"caption": "Figure 1"
|
|
218
|
+
}
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
**Fields:** `chartType` (required), `categories` (required), `series` (required), `title`, `caption`, `width` (inches, default 6), `height` (inches, default 3.5)
|
|
222
|
+
|
|
223
|
+
### Diagram Block
|
|
224
|
+
|
|
225
|
+
Renders a diagram as a high-resolution PNG image embedded in the document. Uses diagram definition syntax (flowcharts, sequences, state machines, ER diagrams, etc.). Useful for architecture diagrams, technical visuals in PDDs and design documents.
|
|
226
|
+
|
|
227
|
+
```json
|
|
228
|
+
{
|
|
229
|
+
"type": "diagram",
|
|
230
|
+
"title": "System Architecture",
|
|
231
|
+
"diagram": {
|
|
232
|
+
"code": "graph TD\n A[Web Client] --> B[API Gateway]\n B --> C[Auth Service]\n B --> D[Core Service]\n D --> E[(Database)]",
|
|
233
|
+
"caption": "Figure 3: High-level system architecture"
|
|
234
|
+
},
|
|
235
|
+
"width": 6,
|
|
236
|
+
"alignment": "center"
|
|
237
|
+
}
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
**Fields:**
|
|
241
|
+
- `diagram.code` (string, required): Diagram definition (flowchart, sequence, etc.)
|
|
242
|
+
- `diagram.caption` (string, optional): Caption/legend text below diagram (italic)
|
|
243
|
+
- `title` (string, optional): Bold title above diagram
|
|
244
|
+
- `width` (number, optional): Width in inches (default 6)
|
|
245
|
+
- `height` (number, optional): Height in inches (default: auto from aspect ratio, max 7)
|
|
246
|
+
- `alignment` (string, optional): `left` | `center` | `right` (default: center)
|
|
247
|
+
|
|
248
|
+
**Supported diagram types:** `graph`/`flowchart`, `sequenceDiagram`, `stateDiagram-v2`, `classDiagram`, `erDiagram`, `gantt`, `mindmap`, `timeline`
|
|
249
|
+
|
|
250
|
+
**Tips:**
|
|
251
|
+
- Keep node labels short (3-5 words max)
|
|
252
|
+
- Limit to 8-12 nodes for readability in print
|
|
253
|
+
- Use subgraphs to group related components
|
|
254
|
+
- Colors automatically match the document theme
|
|
255
|
+
- Diagrams are embedded as images (not editable shapes)
|
|
256
|
+
|
|
257
|
+
**Inserting diagrams into existing documents (EDIT path):**
|
|
258
|
+
1. Call `/diagram/render-mermaid` with `{ "code": "flowchart TD..." }` to get a PNG file path
|
|
259
|
+
2. Call `/word/insert/picture` with the returned `imagePath` to place it in the document
|
|
260
|
+
|
|
261
|
+
---
|
|
262
|
+
|
|
263
|
+
## Themes
|
|
264
|
+
|
|
265
|
+
| Theme | Style | Best for |
|
|
266
|
+
|-------|-------|----------|
|
|
267
|
+
| `consulting` | Navy, Calibri | Reports, analysis, proposals |
|
|
268
|
+
| `modern` | Teal, Aptos | Clean contemporary docs |
|
|
269
|
+
| `corporate` | Dark blue, Cambria | Traditional business |
|
|
270
|
+
| `academic` | Black, Times New Roman | Research, papers, theses |
|
|
271
|
+
| `minimal` | Gray, Helvetica Neue | Ultra-clean monochrome |
|
|
272
|
+
| `playful` | Orange, Comic Sans MS / Calibri | Kids, educational, family |
|
|
273
|
+
| `vibrant` | Red/pink, Georgia / Calibri | Travel, food, lifestyle, creative |
|
|
274
|
+
| `nature` | Green, Trebuchet MS / Calibri | Science, animals, environment |
|
|
275
|
+
| `ocean` | Deep blue/aqua, Verdana / Calibri | Marine life, geography, coastal |
|
|
276
|
+
|
|
277
|
+
## Limits
|
|
278
|
+
|
|
279
|
+
| Limit | Value | Applies to |
|
|
280
|
+
|-------|-------|------------|
|
|
281
|
+
| Content blocks per document | 500 | `/doc-gen/generate` total, `/doc-gen/start`+`/doc-gen/add-content` combined |
|
|
282
|
+
| Estimated payload size | 50 MB | Same as above — mainly driven by base64 image data |
|
|
283
|
+
| Images pre-read per document | 50 | Beyond this, remaining `image.path` blocks are left unread (generator reports the error) |
|
|
284
|
+
|
|
285
|
+
These are **per-document** ceilings, so splitting the same content across more `/doc-gen/add-content` calls does NOT help — blocks and payload size are counted across `/doc-gen/start` plus every `add-content` call combined, and the image cap is per document. To get under a limit you must reduce what the document contains: fewer or smaller images, fewer content blocks, or split the output into separate documents.
|
|
286
|
+
|
|
287
|
+
## Troubleshooting
|
|
288
|
+
|
|
289
|
+
| Issue | Fix |
|
|
290
|
+
|-------|-----|
|
|
291
|
+
| "File already exists: \<path\>. Provide a different filename or delete the existing file." | `outputPath` already has a file on disk — doc-gen never overwrites. Pick a new `outputPath`, or delete the existing file first if the user asked to replace it. |
|
|
292
|
+
|
|
293
|
+
## Options Reference
|
|
294
|
+
|
|
295
|
+
| Field | Required | Description |
|
|
296
|
+
| -------------- | -------- | ----------------------------------------------------- |
|
|
297
|
+
| `title` | Yes | Document title |
|
|
298
|
+
| `outputPath` | Yes | Full path for output .docx |
|
|
299
|
+
| `author` | No | Author name |
|
|
300
|
+
| `company` | No | Company name |
|
|
301
|
+
| `theme` | No | consulting, modern, corporate, academic, minimal |
|
|
302
|
+
| `templatePath` | No | Path to a .docx template file — extracts theme (fonts, colors, sizes, spacing), page setup (margins, page size, orientation), and headers/footers. **Overrides `theme` when set.** User-specified options (margins, headerFooter, etc.) take priority over template-extracted values. |
|
|
303
|
+
| `pageSize` | No | LETTER, A4, LEGAL, A5 |
|
|
304
|
+
| `orientation` | No | portrait, landscape |
|
|
305
|
+
| `margins` | No | {top, bottom, left, right} in inches |
|
|
306
|
+
| `headerFooter` | No | header/footer with text, alignment, includePageNumber |
|
|
307
|
+
| `pageBorder` | No | {style, color, size} |
|
|
308
|
+
| `pageBackgroundColor` | No | Hex color for page background (e.g. `FFF8F0` for warm cream) |
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
# Template: Professional
|
|
2
|
+
|
|
3
|
+
**Use for:** Analyst reports, market analysis, business proposals, executive briefings, financial documents, competitive analysis, investment memos.
|
|
4
|
+
|
|
5
|
+
## Structure
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
Cover Page -> TOC -> Executive Summary -> Background/Context -> Analysis Sections (3-5) -> Recommendations -> Conclusion -> Appendix (optional)
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Heading Style
|
|
12
|
+
|
|
13
|
+
Numbered at ALL levels. No exceptions.
|
|
14
|
+
|
|
15
|
+
- H1: `"1. Executive Summary"`, `"2. Market Analysis"`, `"3. Financial Performance"`
|
|
16
|
+
- H2: `"2.1 Revenue Breakdown"`, `"2.2 Margin Trends"`, `"2.3 Outlook"`
|
|
17
|
+
- H3: `"2.1.1 APAC Region"`, `"2.1.2 EMEA Region"`
|
|
18
|
+
|
|
19
|
+
A heading without a number prefix is WRONG.
|
|
20
|
+
|
|
21
|
+
## Required Elements
|
|
22
|
+
|
|
23
|
+
| Element | Requirement |
|
|
24
|
+
|---------|------------|
|
|
25
|
+
| Cover page | Title, subtitle, author, date, company |
|
|
26
|
+
| TOC | After cover page |
|
|
27
|
+
| Executive Summary | First section, standalone, decision-ready |
|
|
28
|
+
| Page breaks | Before EVERY H1 heading |
|
|
29
|
+
| Horizontal lines | Between H2 sub-sections |
|
|
30
|
+
| Footnotes | Minimum 5 -- every data claim needs a source |
|
|
31
|
+
| Callout boxes | 4+ using varied styles (info, warning, tip, note) |
|
|
32
|
+
| TextBox | 1+ for executive quote or key highlight |
|
|
33
|
+
| Charts | After every data table -- DIVERSIFY types (column, pie, line, radar) |
|
|
34
|
+
| Tables | Every section -- comparison tables, scorecards, financial data |
|
|
35
|
+
| Bookmarks | On every H1 heading |
|
|
36
|
+
|
|
37
|
+
## Content Rules
|
|
38
|
+
|
|
39
|
+
- **Minimum 3 paragraphs per H1, 2 per H2** -- real analysis, not filler
|
|
40
|
+
- **Every heading must have 2+ paragraphs BEFORE any table or list**
|
|
41
|
+
- **Tables need 4+ data rows** -- use qualitative labels (Strong/Moderate/Weak), star ratings
|
|
42
|
+
- **Aim for 12,000+ characters** total content
|
|
43
|
+
- **Every table MUST have a `caption`** with source attribution
|
|
44
|
+
|
|
45
|
+
## Consulting Frameworks (Apply These)
|
|
46
|
+
|
|
47
|
+
### The Pyramid Principle
|
|
48
|
+
Start with the main conclusion/recommendation upfront, then supporting arguments. The reader grasps the core message immediately.
|
|
49
|
+
```
|
|
50
|
+
[Main Conclusion]
|
|
51
|
+
/ | \
|
|
52
|
+
[Argument 1] [Argument 2] [Argument 3]
|
|
53
|
+
/ \ | \ / \
|
|
54
|
+
[Data] [Data] [Data] [Data] [Data] [Data]
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Action Titles (NOT Label Titles)
|
|
58
|
+
Headings should state conclusions, not topics. When read in sequence, the headings alone tell the story.
|
|
59
|
+
|
|
60
|
+
| Label Title (BAD) | Action Title (GOOD) |
|
|
61
|
+
|-------------------|---------------------|
|
|
62
|
+
| "Q3 Revenue Overview" | "Q3 revenue exceeded targets by 15% driven by APAC growth" |
|
|
63
|
+
| "Market Analysis" | "Three market segments show highest growth potential" |
|
|
64
|
+
| "Recommendations" | "Investing $2M in expansion will yield 3x ROI within 18 months" |
|
|
65
|
+
|
|
66
|
+
Use Action Titles for H2/H3 subsections. H1 headings can be label-style ("2. Financial Performance") since they serve as section anchors.
|
|
67
|
+
|
|
68
|
+
### The "So What?" Test
|
|
69
|
+
For every data point, ask "So what?" If you can't answer it, the content may not be necessary. The answer becomes your insight or Action Title.
|
|
70
|
+
|
|
71
|
+
### MECE Structure
|
|
72
|
+
**M**utually **E**xclusive, **C**ollectively **E**xhaustive — sections should not overlap and should cover all relevant aspects. Example: segment by geography (APAC, EMEA, Americas) not by vague categories ("large companies, tech companies, growing companies").
|
|
73
|
+
|
|
74
|
+
### Executive Summary Rules
|
|
75
|
+
1. **Opening**: Main conclusion (1-2 sentences)
|
|
76
|
+
2. **Key Arguments**: 2-4 supporting points (1 paragraph each)
|
|
77
|
+
3. **Implications**: What this means for the reader
|
|
78
|
+
4. **Call to Action**: What decision is needed
|
|
79
|
+
- Should stand alone — reader gets full picture without the rest
|
|
80
|
+
- Length: 1-2 pages max (10% of document)
|
|
81
|
+
- Write LAST but place FIRST
|
|
82
|
+
|
|
83
|
+
## Tone & Style
|
|
84
|
+
|
|
85
|
+
- Formal, data-driven, third person
|
|
86
|
+
- Active voice: "Revenue grew 15%" not "A 15% growth was observed"
|
|
87
|
+
- No filler phrases: cut "it is important to note", "going forward"
|
|
88
|
+
- Past tense for historical, present for current, future for projections
|
|
89
|
+
- The "newspaper test": if it sounds like a bulleted list, rewrite as analytical prose
|
|
90
|
+
|
|
91
|
+
## Borrowed Best Practices
|
|
92
|
+
|
|
93
|
+
### KPI Summary Cards (single-row table with big numbers)
|
|
94
|
+
Use a single-row, multi-column table to present key metrics prominently at the top of a section:
|
|
95
|
+
```json
|
|
96
|
+
{
|
|
97
|
+
"type": "table",
|
|
98
|
+
"headers": ["Revenue", "ARR", "Gross Margin", "Free Cash Flow"],
|
|
99
|
+
"rows": [["$1.43B (+9% YoY)", "$1.67B (+14% YoY)", "83% (stable)", "$328M (strong)"]],
|
|
100
|
+
"caption": "FY2025 Key Performance Indicators"
|
|
101
|
+
}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Visual Bar Charts in Tables (Unicode blocks)
|
|
105
|
+
For inline data visualization without images, use Unicode block characters in table cells:
|
|
106
|
+
```json
|
|
107
|
+
{
|
|
108
|
+
"type": "table",
|
|
109
|
+
"headers": ["Metric", "Value", "Visual"],
|
|
110
|
+
"rows": [
|
|
111
|
+
["UiPath", "38%", "##################################################"],
|
|
112
|
+
["Automation Anywhere", "22%", "#############################"],
|
|
113
|
+
["Others", "40%", "####################################################"]
|
|
114
|
+
],
|
|
115
|
+
"caption": "Market share visualization"
|
|
116
|
+
}
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### Era/Timeline Tables (multi-column evolution view)
|
|
120
|
+
Show company or product evolution as a horizontal timeline:
|
|
121
|
+
```json
|
|
122
|
+
{
|
|
123
|
+
"type": "table",
|
|
124
|
+
"headers": ["2005-2018", "2019-2022", "2023-2025", "2026+"],
|
|
125
|
+
"rows": [["Era 1: RPA Pioneer. Founded by Daniel Dines...", "Era 2: Enterprise Scale. IPO, global expansion...", "Era 3: Agentic AI. Platform pivot...", "Era 4: AI-Native. Full autonomy..."]],
|
|
126
|
+
"caption": "UiPath Platform Evolution"
|
|
127
|
+
}
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### Scorecard Tables (conditional formatting auto-applied)
|
|
131
|
+
Use qualitative labels that get auto-colored by the generator:
|
|
132
|
+
```json
|
|
133
|
+
{
|
|
134
|
+
"type": "table",
|
|
135
|
+
"headers": ["Capability", "UiPath", "Microsoft", "ServiceNow"],
|
|
136
|
+
"rows": [
|
|
137
|
+
["RPA Depth", "Strong", "Moderate", "Weak"],
|
|
138
|
+
["AI Integration", "Strong", "Strong", "Moderate"],
|
|
139
|
+
["Enterprise Scale", "Strong", "Strong", "Strong"],
|
|
140
|
+
["Pricing", "Moderate", "Strong", "Weak"]
|
|
141
|
+
],
|
|
142
|
+
"caption": "Competitive capability comparison (auto-colored)"
|
|
143
|
+
}
|
|
144
|
+
```
|
|
145
|
+
Add `"conditionalFormatting": true` to enable auto-coloring: "Strong" = green bold, "Moderate" = orange bold, "Weak" = gray italic. Also works with star ratings, scores (9/10, A+), and +/- percentages.
|
|
146
|
+
|
|
147
|
+
## Example Heading Sequence
|
|
148
|
+
|
|
149
|
+
```
|
|
150
|
+
1. Executive Summary
|
|
151
|
+
2. Company Overview
|
|
152
|
+
2.1 History and Mission
|
|
153
|
+
2.2 Product Portfolio
|
|
154
|
+
2.3 Market Position
|
|
155
|
+
3. Financial Performance
|
|
156
|
+
3.1 Revenue and Growth
|
|
157
|
+
3.2 Profitability Analysis
|
|
158
|
+
3.3 Balance Sheet
|
|
159
|
+
4. Competitive Landscape
|
|
160
|
+
4.1 Key Competitors
|
|
161
|
+
4.2 Capability Comparison
|
|
162
|
+
4.3 Market Share
|
|
163
|
+
5. Future Outlook
|
|
164
|
+
5.1 Growth Drivers
|
|
165
|
+
5.2 Risk Factors
|
|
166
|
+
5.3 Scenarios (Bull/Base/Bear)
|
|
167
|
+
6. Conclusion and Recommendations
|
|
168
|
+
```
|