@uipath/delegate-sdk 1.203.1 → 1.203.2
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 +722 -0
- package/dist/skills/business-analysis/as-is-capture.md +440 -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 +215 -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 +81 -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,562 @@
|
|
|
1
|
+
# PDD Template — Structure, Sourcing, Style
|
|
2
|
+
|
|
3
|
+
Section structure, wiki sourcing, and content rules for generating a Process Definition Document. `pdd-generation.md` reads this file and orchestrates the draft composition.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
## Ingestion Order
|
|
7
|
+
|
|
8
|
+
Read `index.md` first for the wiki domain, page catalog, and `language:` — the document language every heading, prose block, table cell and `TBD:` reason below is written in (see Document Language in `SKILL.md`). Then fetch specific files per section below; don't load the whole wiki upfront. To discover wiki shape, `ls` the folders directly.
|
|
9
|
+
|
|
10
|
+
## Section Structure
|
|
11
|
+
|
|
12
|
+
A PDD has these H1 blocks in order. No ad-hoc additions or deletions. If a section has no content, write "Not applicable for this process." Each subsection lists its **Source** (wiki path) inline. Mandatory placeholders are called out where they belong; if the real visual is missing, insert the placeholder.
|
|
13
|
+
|
|
14
|
+
Open items: Put each `==TBD: reason==` marker in its own standalone paragraph. The reason is in the document's language and MUST NOT contain `==`; the canonical keyword is uppercase `TBD:`. Do not place open-item markers in headings, list items, callouts, or table cells. Never leave a bare "TBD".
|
|
15
|
+
|
|
16
|
+
Open-item lifecycle:
|
|
17
|
+
|
|
18
|
+
- Confirmed facts are ordinary content. Write the value in prose or table cells; remove its `==TBD: reason==` markers.
|
|
19
|
+
- Status markers do not exist. Never emit `==Resolved: ...==`, `==Confirmed: ...==`, or `==Done: ...==`.
|
|
20
|
+
- Partial answer → write the known value; keep one focused standalone `==TBD: reason==` marker for the remaining gap.
|
|
21
|
+
- `Resolved`/`Confirmed`/`Done` marker around a confirmed fact → replace it with ordinary content.
|
|
22
|
+
|
|
23
|
+
H1 block order: **Cover Page · Document Control · Table of Contents (download only) · 1 Business Context · 2 Scope · 3 Current State · 4 Future State · 5 Business Rules · 6 Data Model · 7 People · 8 Exceptions & Error Handling · 9 Compliance & Regulatory · 10 KPIs & Acceptance Criteria · 11 Assumptions, Constraints, Dependencies & Risks · 12 Glossary · 13 Next Steps · Appendix A**.
|
|
24
|
+
|
|
25
|
+
### Cover Page
|
|
26
|
+
|
|
27
|
+
Host-synthesized at render/Download from the `pdd:doc` marker + sidecar. Do not author a cover in the draft body. Collect at the metadata STOP: process name, client, author, date — the orchestrator writes them into the `pdd:doc` marker.
|
|
28
|
+
|
|
29
|
+
### Document Control
|
|
30
|
+
|
|
31
|
+
Host-synthesized at render/Download (heading + version-history table from the `pdd:doc` marker + sidecar). Do not author a Document Control block in the draft body.
|
|
32
|
+
|
|
33
|
+
> **Single source of truth (actors):** the *full* actor catalog — every human and system persona referenced anywhere, including governance/sign-off roles (Process Owner, SMEs, BA, Solution Architect) — lives once in **§7.1 Roles & Personas**. Do not duplicate personas in §1.
|
|
34
|
+
|
|
35
|
+
### Table of Contents
|
|
36
|
+
|
|
37
|
+
Host-synthesized at Download (`maxLevel: 2`) as export furniture, followed by a host-owned page break. Do not author a TOC or page breaks in the living draft. The host derives viewer section navigation from the section anchors below. The downloaded Word TOC is generated by the host during export.
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
### Section 1: Business Context
|
|
42
|
+
|
|
43
|
+
Heading: `"1. Business Context"`. Three H2 subsections.
|
|
44
|
+
|
|
45
|
+
**1.1 Problem Statement** — Source: `as-is/overview.md` + `as-is/pain-points.md`. One dense paragraph (2–4 sentences): volume handled, the headline failure metric, the human cost (handling time / system pivots), and the compliance or revenue exposure. Bold system names on first mention. Every number grounded in the wiki — never invent metrics.
|
|
46
|
+
|
|
47
|
+
**1.2 Objectives** — Source: `to-be/overview.md` + `to-be/kpis.md`. Bulleted list. Each objective pairs a baseline with a target and names the mechanism ("Raise X from 74.2% to >92% by …"). Cover operational and compliance objectives.
|
|
48
|
+
|
|
49
|
+
**1.3 Expected Value** — Source: `to-be/benefits.md`. **Qualitative** value framing (a short paragraph or 3–5 bullets of business outcomes). Do **not** restate the numeric KPI targets here — the authoritative target table is **§10**. Reference it ("see Section 10 for measured targets").
|
|
50
|
+
|
|
51
|
+
> **Single source of truth (targets):** numeric baselines live in §3.3 Metrics; numeric targets and acceptance thresholds live in §10. §1.3 stays qualitative. This removes the triple-listing of the same target numbers across §1, §3, and §10.
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
### Section 2: Scope
|
|
56
|
+
|
|
57
|
+
Heading: `"2. Scope"`. Three H2 subsections, plus 2.4 when related processes exist.
|
|
58
|
+
|
|
59
|
+
**2.1 Process Identity** — Source: metadata STOP. Table (caption required): Process name, Process group, Process identifier, Industry.
|
|
60
|
+
|
|
61
|
+
**2.2 Scope Boundaries** — Source: `as-is/scope.md` if exists; otherwise derive the boundaries from the confirmed snapshots and `queries/open-questions.md`, and flag genuinely unresolved boundaries as open items — never a new question at generation time. MUST be a 2-column table (In Scope | Out of Scope), caption required. One item per row; pad the shorter column with empty cells. Noun phrase + brief qualifier, not full sentences. **Consistency guardrail:** nothing listed Out of Scope may be described as an in-flow step in §3, §4, or §8 — cross-check before finalizing.
|
|
62
|
+
|
|
63
|
+
**2.3 Systems and Applications** — Source: `entities/applications/`. One row per app page. Table (caption required, columns: System | Role in Process | Access Type). Bold system name on first mention in cell. Access type: read / write / both. Use the customer's exact system names — never generic terms. Name UiPath products explicitly where used (Maestro, Document Understanding, Integration Service, Action Center, AI Agents). No narrative.
|
|
64
|
+
|
|
65
|
+
**2.4 Related Processes and Tasks** — Source: `entities/processes/`. Only when that folder has pages; otherwise omit 2.4 entirely (no "Not applicable" line). Table (caption required, columns: Process or task | Type | Relationship | Documented in). One row per page: the name as the user gave it; Type is business process or business task; Relationship as stated, and for a sub-process the map node it details; Documented in is the document or project name, or the document-language equivalent of "Not documented yet". Name documents by title, never by file path. Other sections name a related process and point to §2.4; never repeat the table.
|
|
66
|
+
|
|
67
|
+
> **Dependencies are not in §2.** Hard/soft dependencies live once in **§11.3** (consolidated with assumptions, constraints, and risks). If a reader needs them early, point to §11 — do not duplicate a dependencies table here.
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
### Section 3: Current State (As-Is)
|
|
72
|
+
|
|
73
|
+
Heading: `"3. Current State"`. Four H2 subsections.
|
|
74
|
+
|
|
75
|
+
**Route-specific current-state rule** — Existing work uses the AS-IS structure below. New + RPA, New + Case, and New + BPMN do not have a current-state process to document. For new work, keep the `"3. Current State"` section but write a short statement that the capability is net-new and AS-IS is not applicable, sourced from the confirmed TO-BE facts. Do not invent a current flow, metrics, pain points, or AS-IS diagram for new work.
|
|
76
|
+
|
|
77
|
+
**BPMN AS-IS source** — When existing work has an approved `as-is/process.bpmn` (authored under a BPMN capture format, or user-supplied), it is the current-state process model of record. Source the current-state narrative from it alongside the normal AS-IS pages. Embed its exact, complete BPMN XML in §3.4 as the rendered AS-IS diagram; the source may omit BPMNDI because Delegate resolves geometry at render time. Do not convert it to Mermaid or create a duplicate flowchart. When that file is absent, the PDD uses the canonical Mermaid fragment `as-is/diagram.md`. An overview-embedded Mermaid block remains a legacy live-view fallback only; it must not become a PDD source.
|
|
78
|
+
|
|
79
|
+
**3.1 Overview** — Source: `as-is/overview.md`. 2–3 sentence framing paragraph describing the current manual workflow end-to-end: systems touched, where data is re-keyed, where silent failures occur, where compliance clocks start unmonitored.
|
|
80
|
+
|
|
81
|
+
**3.2 Current Flow** — Source: `as-is/steps/` or `as-is/overview.md`. Not a prose walkthrough. Layout depends on where the steps came from:
|
|
82
|
+
|
|
83
|
+
- **Default layout:** numbered-step table (columns: # | Current step), 5–12 rows.
|
|
84
|
+
- **Recording layout:** `as-is/steps/` pages carry `Recording:` ranges (steps captured from a screen recording). Execution detail: one row per step page, never merged. No row cap: a 2-hour walkthrough yields 50+ steps.
|
|
85
|
+
1. Sub-process overview table (caption required, columns: `No | Sub-process | Recording range | Steps`). Sub-processes come from the step pages' `Sub-process:` (Case route: their AS-IS stage), named as on the AS-IS map. Recording range runs from the first step's start to the last step's end; Steps is the row count.
|
|
86
|
+
2. Per sub-process, an H3 `3.2.<No> <Sub-process>`: a 2–4 sentence intro (purpose, actor, systems, hand-off), then its steps in the step layout `DocTemplates.pdd` names: `step-table` (also when absent) or `step-cards`. A PDD that already exists keeps the layout its `pdd:doc` `template=` names; switch only when the user asks. `step-table` is the step table (caption required, columns: `Step | Current activity | Remarks | Step screenshots`):
|
|
87
|
+
- Step: `<No>.<n>` (`2.1`, `2.2`, …). Rules, decision points, exceptions and open items cite this number.
|
|
88
|
+
- Current activity: the action, then `Recording: mm:ss–mm:ss` (`h:mm:ss` past one hour). A step the recording does not show writes `Not in recording`.
|
|
89
|
+
- Remarks: one `• ` item per field, value, filter or button the step touches, named exactly as on screen. A cell is one line: separate items with spaces, never `<br>`. Annotated frame → open each item with its callout number (①, ②, …).
|
|
90
|
+
- Step screenshots: the step page's frames, each ``, no caption. No frame → `—`, plus one Screenshot Placeholder after the table naming those steps.
|
|
91
|
+
|
|
92
|
+
`step-cards` gives each step its own block in place of a table row, with the same content: a bold one-line paragraph `**<No>.<n> <Current activity>** · *Recording: mm:ss–mm:ss*`, never a heading; the Remarks items as a Markdown list, one item each, callout number first; then each frame as a standalone `` at full width, no caption. No frame → no image, plus one Screenshot Placeholder after the sub-process naming those steps.
|
|
93
|
+
3. After the last sub-process, three H3 blocks, rows in step order:
|
|
94
|
+
- **Decision points** — table `Step | Condition | Action`, one row per outcome. Source: the `## Decision points` table in `as-is/business-rules.md`.
|
|
95
|
+
- **Exceptions** — table `Step | Exception | Current handling`. Source: `as-is/exception-handling.md`.
|
|
96
|
+
- **Open items** — the step-level gaps from `queries/open-questions.md` and the step pages, grouped by sub-process: a bold `3.2.<No> <Sub-process>` paragraph, then one standalone `==TBD: [n] reason==` paragraph per item. Number items `[1]`, `[2]`, … without restarting per sub-process; a Remarks item may cite `[n]`.
|
|
97
|
+
|
|
98
|
+
> **Step-overflow rule (applies to the default §3.2 table and §4.2; the recording layout groups by sub-process instead):** a flow longer than ~12 steps must not render as one flat table. Group into 3–6 named stages, one table per stage, steps sub-numbered within it (`2.1`, `2.2`, …). Stage names match the diagram's stage/subgraph names where a diagram or `stages.md` exists — same vocabulary across map and tables. Never merge distinct actions into one row to fit the cap.
|
|
99
|
+
|
|
100
|
+
**3.3 Metrics** — Source: `as-is/metrics.md` / `as-is/pain-points.md` (legacy fallback: `as-is/volumetrics.md`). Table (caption required, columns: Metric | Current signal | Measurement method). **Baselines and how they're measured only** — targets live in §10. Keep exact numbers from the wiki.
|
|
101
|
+
|
|
102
|
+
**3.4 Pain Points** — Source: `as-is/pain-points.md`. Table (caption required, columns: Where | What breaks | Impact). Each row connects a location to a concrete failure mode to a quantified impact. End with the route-specific AS-IS map: embed `as-is/process.bpmn` as BPMN when it is the approved source; otherwise embed the complete Mermaid fragment from `as-is/diagram.md`. A missing or invalid canonical map blocks PDD assembly; never substitute Mermaid from `as-is/overview.md`.
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
### Section 4: Future State (To-Be)
|
|
107
|
+
|
|
108
|
+
Heading: `"4. Future State"`. Source: `to-be/` (overview, steps, benefits).
|
|
109
|
+
|
|
110
|
+
**RPA TO-BE source** — When the future state is RPA, source this section from `to-be/overview.md`, canonical `to-be/diagram.md`, `to-be/stages.md` when present, `to-be/delivery-model.md`, `to-be/steps/`, `to-be/exception-handling.md`, and `to-be/benefits.md`. Section 4 must describe automation units/steps with mode, owner or system, trigger, inputs, outputs, rule/decision points, exception path, and known manual review. If the user provided primary or secondary stages, reconcile the automation units against `to-be/stages.md` and do not silently drop excluded stages from the source trace. Do not use Case task type or Case work pattern columns for RPA future states.
|
|
111
|
+
|
|
112
|
+
**BPMN TO-BE source** — When the future state is BPMN, source this section from `to-be/overview.md`, `to-be/process.bpmn`, `to-be/bpmn-details.md`, `to-be/transformation-decisions.md`, `to-be/participants-and-lanes.md`, `to-be/events-and-triggers.md`, `to-be/activities.md`, `to-be/gateways-and-routes.md`, `to-be/message-and-timer-flows.md`, `to-be/data-objects.md`, `to-be/exception-handling.md`, and `to-be/benefits.md`. Section 4 must describe the BPMN process model with participants/pools, lanes, start/intermediate/end events, activities/subprocesses, gateways, message/timer waits, data objects, systems, exception routes, message flows, sequence flows, and terminal outcomes. The confirmed BPMN 2.0 model from `to-be/process.bpmn` must be embedded in §4.1 as the rendered TO-BE diagram; do not replace it with a Mermaid flowchart or generic TO-BE Diagram Placeholder.
|
|
113
|
+
|
|
114
|
+
**Case TO-BE source** — When the future state is a case, source this section from `to-be/overview.md`, canonical `to-be/diagram.md`, `to-be/case-details.md`, `to-be/transformation-decisions.md`, `to-be/stages/`, `to-be/decisions-and-routes.md`, `to-be/data-and-evidence.md`, `to-be/exception-handling.md`, `to-be/slas.md`, `to-be/personas.md`, and `to-be/benefits.md`. Section 4 must include case stages and case tasks with owner, Case task type, Case work pattern, trigger, inputs, outputs, required completion, decision routes, SLA, and exceptions. Valid Case task type values are `process`, `agent`, `rpa`, `action`, `api-workflow`, `case-management`, `execute-connector-activity`, `wait-for-connector`, and `wait-for-timer`. Valid case work patterns include human action/review, AI agent reasoning, system workflow/process, connector/API operation, external event wait, timer wait, legacy UI/RPA automation, and child case. The PDD is the confirmed business-design input for the Solution Design Document; keep implementation-level Case Definition Blueprint detail in the SDD phase. §4.2.1 projects one block per stage from `to-be/stages/<stage-id>.md` — a stage in the confirmed map with no stage page is a missing source — write it before assembly, never fill the block from the map alone.
|
|
115
|
+
|
|
116
|
+
**4.1 Vision** — One paragraph: the redesigned orchestrated flow, which UiPath products orchestrate it, where AI agents act, where humans are retained for high-judgment decisions, the end-state throughput/quality. End with a TO-BE map. In living-draft mode, RPA and Case routes embed the complete Mermaid fragment from `to-be/diagram.md`, followed by `[Open TO-BE diagram](delegate:open-diagram?which=to-be&anchor=target-state)`. BPMN routes embed the rendered BPMN model from `to-be/process.bpmn` and include the same Open TO-BE diagram link. A missing or invalid canonical map blocks PDD assembly; do not substitute Mermaid from `to-be/overview.md`.
|
|
117
|
+
|
|
118
|
+
**4.2 Target Flow** — Route-specific table (step-overflow rule from §3.2 applies):
|
|
119
|
+
- RPA: columns `# | Automation unit / step | Mode | Owner or system | Input | Output | Exception path`. Do not use stage-only fields unless the user actually described stages.
|
|
120
|
+
- BPMN: columns `# | BPMN element | Participant / lane | Element type | Input / message | Output / message | Route / exception path`. Element type is one of start event, end event, activity, subprocess, gateway, message event, timer event, data object, or exception route.
|
|
121
|
+
- Case: columns `# | Stage | Owner | Required for completion`. Main-path stages first (`yes`), then conditional exception stages (`conditional` — never `yes`). Every Owner must be a role defined in §7.
|
|
122
|
+
|
|
123
|
+
**4.2.1 Future Work Details** — THE CORE. Use the route-specific shape:
|
|
124
|
+
- RPA: one block per automation unit or step. Include trigger, mode, system(s), inputs, outputs, business rules/decision points, exception path, screenshots/sample data placeholders when relevant, and whether human review remains. Do not include Case task type or Case work pattern.
|
|
125
|
+
- BPMN: one block per participant/lane or subprocess:
|
|
126
|
+
1. One-line `>` (note callout) lane/subprocess purpose.
|
|
127
|
+
2. Header table: Trigger/event, Activities, Key gateway, Owner/participant, Flows From, Flows To, Inputs/messages, Outputs/messages.
|
|
128
|
+
3. Element table (columns: # | BPMN element | Element type | System(s) / participant | Description). Every gateway has explicit outcomes; every timer/message wait has a trigger and resume path; every exception route returns to the main flow or reaches a terminal outcome.
|
|
129
|
+
- Case: one block per stage, sourced entirely from its `to-be/stages/<stage-id>.md` page, including its task table:
|
|
130
|
+
1. One-line `>` (note callout) stage purpose.
|
|
131
|
+
2. Header table: Stage kind (primary or secondary; interrupting?), Required for completion, Activated by, SLA (target, at-risk point, response), Tasks (count + breakdown by Case work pattern), Key decision (a quantified branch), Owner, Flows From, Flows To, Inputs, Outputs.
|
|
132
|
+
3. Task table (columns: # | Case task | Case task type | Case work pattern | Activation | System(s) | Description). `Case task type` uses the supported downstream enum; `Case work pattern` is the business-readable label such as human action/review, AI agent reasoning, system workflow/process, connector/API operation, external event wait, timer wait, legacy UI/RPA automation, or child case; `Activation` is in order / side by side / on demand / on event, with run-once and skip-when noted in the cell when captured. **Threshold rule:** any confidence/quality gate states a numeric threshold (e.g. "DU confidence < 0.88 → halt & route to re-scan"); never "low confidence" or "if quality is good".
|
|
133
|
+
|
|
134
|
+
**4.3 What Changes** — Table (columns: Area | AS-IS | TO-BE | Why | How). All four columns populated. Follow the table with **one** short rationale paragraph for any net-new reasoning not captured in the Why/How columns. (This merges the former "Transformation Rationale" — do not repeat the table's content as prose.)
|
|
135
|
+
|
|
136
|
+
**4.4 Automation / BPMN / Case Work Summary** — Brief rollup only: counts by automation type for RPA future states, counts by BPMN element type for BPMN future states, or counts by Case work pattern for case future states, plus the few candidates that still need a decision. **Do not restate the per-task or per-element table from §4.2.1** (every task/element is already typed there). One small table or 2–3 bullets.
|
|
137
|
+
|
|
138
|
+
---
|
|
139
|
+
|
|
140
|
+
### Section 5: Business Rules
|
|
141
|
+
|
|
142
|
+
Heading: `"5. Business Rules"`. Source: `as-is/business-rules.md` + `to-be/business-rules.md` (overrides where a rule changes in automation).
|
|
143
|
+
|
|
144
|
+
Table (caption required, columns: Rule ID | Description). One rule per row, IDs BR-001, BR-002, …. 1–2 sentences each; sub-conditions as a bulleted list inside the cell. Each rule states concrete thresholds/time windows and is grounded in a regulation or customer policy where applicable.
|
|
145
|
+
|
|
146
|
+
Recording layout (§3.2): columns `Rule ID | Step | Rule | Recording`. Step is the §3.2 step where the rule shows; Recording is its `mm:ss–mm:ss`. A TO-BE-only rule writes `—` in both.
|
|
147
|
+
|
|
148
|
+
> **Mapping lives in §9, not here.** Keep BR descriptions clean; the **§9.1 traceability matrix** owns the BR→stage/task mapping. Don't inline a stage/Source column. The recording layout's Step and Recording columns are evidence of where the rule shows today, not that mapping.
|
|
149
|
+
|
|
150
|
+
---
|
|
151
|
+
|
|
152
|
+
### Section 6: Data Model
|
|
153
|
+
|
|
154
|
+
Heading: `"6. Data Model"`. Source: `entities/artifacts/` + `as-is/data-inputs-outputs.md`.
|
|
155
|
+
|
|
156
|
+
**6.1 Entities** — Table (Entity | Description). Include the primary business record and the objects all stages read/write.
|
|
157
|
+
|
|
158
|
+
**6.2 Data Inputs and Outputs** — Table (caption required, columns: Artifact | Source / Destination | Format | Consumed / Produced By). Bold artifact names on first mention. The strongest lineage artifact — be exhaustive.
|
|
159
|
+
|
|
160
|
+
**6.3 Field-Level Data Dictionary** — Table (columns: Field | Type | Format / Pattern | Valid values / range | Mandatory | Privacy class). For each field that drives a decision, binding, or compliance check. Mark PII / Tokenized explicitly.
|
|
161
|
+
|
|
162
|
+
**6.4 Data Flow & Lineage** — Numbered table (# | Data movement) tracing the primary record end-to-end. Step-numbered, not one run-on sentence.
|
|
163
|
+
|
|
164
|
+
**6.5 Integrations** — Table (columns: Integration (System → System) | Fields passed | Connector / type | Endpoint + Auth). Where endpoint/auth is unknown, write the document-language equivalent of "Not confirmed" in the cell rather than omitting the column, then add a standalone `==TBD: confirm the integration endpoint and authentication at SDD==` paragraph immediately after the table.
|
|
165
|
+
|
|
166
|
+
---
|
|
167
|
+
|
|
168
|
+
### Section 7: People
|
|
169
|
+
|
|
170
|
+
Heading: `"7. People"`. Source: `entities/people/`.
|
|
171
|
+
|
|
172
|
+
**7.1 Roles & Personas** — THE canonical actor catalog. Table (Stakeholder | Responsibility). Define **every** actor — human and system — referenced anywhere in the document. Consolidate aliases into one canonical name (note the alias). No task may be owned by an undefined actor. (Document Control and §1 reference this; they do not duplicate it.)
|
|
173
|
+
|
|
174
|
+
**7.2 RACI** — Per-stage RACI table (Activity/Stage | Responsible | Accountable | Consulted | Informed). Automated tasks → system personas; manual → human personas; prefer a human team in Responsible/Accountable.
|
|
175
|
+
|
|
176
|
+
---
|
|
177
|
+
|
|
178
|
+
### Section 8: Exceptions & Error Handling
|
|
179
|
+
|
|
180
|
+
Heading: `"8. Exceptions and Error Handling"`. Source: `as-is/exception-handling.md` + `to-be/exception-handling.md`.
|
|
181
|
+
|
|
182
|
+
**8.1 Known Exceptions** — Table (columns: Exception | Trigger | AS-IS Handling | TO-BE Handling). Show the before/after contrast. Every exception has a defined trigger and a TO-BE resolution path that returns to the main flow or reaches a terminal state (no orphaned exceptions, no infinite loops). Recording layout: §3.2 Exceptions owns the current handling; AS-IS Handling cites its step (`See step 2.3`).
|
|
183
|
+
|
|
184
|
+
**8.2 Exception Data State Transitions** — Table (columns: Exception | Affected record | State on entry | State on resolution | State on terminal failure). What happens to the record on each path (held / flagged / released / quarantined / archived).
|
|
185
|
+
|
|
186
|
+
**8.3 HITL & Action Center Task Form Specifications** — Table (columns: Escalation point | Trigger | Fields surfaced | Available actions → resulting state | Task SLA | Assignee role). For every human-in-the-loop escalation; a developer must be able to build the form from this table alone. Add a Screenshot Placeholder per form if no real screenshot exists.
|
|
187
|
+
|
|
188
|
+
---
|
|
189
|
+
|
|
190
|
+
### Section 9: Compliance & Regulatory
|
|
191
|
+
|
|
192
|
+
Heading: `"9. Compliance and Regulatory"`. Source: `as-is/compliance.md` (or legacy `compliance/` pages) + `to-be/business-rules.md`.
|
|
193
|
+
|
|
194
|
+
**9.1 Compliance Traceability Matrix** — Table (columns: Requirement / Rule | Enforced at | Evidence retained). Map each regulation AND each BR (from §5) to the stage/task that enforces it and the evidence retained. Every BR in §5 must appear here.
|
|
195
|
+
|
|
196
|
+
**9.2 Audit & Traceability** — Paragraph: what is timestamped and cross-referenced across systems, what evidence proves each compliance window, the retention obligation.
|
|
197
|
+
|
|
198
|
+
If the process has no regulatory dimension, write "Not applicable for this process."
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
|
|
202
|
+
### Section 10: KPIs & Acceptance Criteria
|
|
203
|
+
|
|
204
|
+
Heading: `"10. KPIs and Acceptance Criteria"`. Source: `to-be/kpis.md` — the numeric artifact, one row per KPI (baseline with its measurement method, target, acceptance signal, owner). `to-be/benefits.md` is qualitative by contract and is **not** a source for this section or for §1.2's baseline-and-target pair; take every figure from `to-be/kpis.md` and never derive one from the qualitative page.
|
|
205
|
+
|
|
206
|
+
**10.1 KPIs** — THE authoritative target table (caption required, columns: KPI | Target / acceptance signal). This is the single source for numeric targets (§1.3 and §3.3 reference it).
|
|
207
|
+
|
|
208
|
+
**10.2 Acceptance Criteria** — Bulleted list, each objectively measurable (rolling window, threshold, or zero-breach condition).
|
|
209
|
+
|
|
210
|
+
---
|
|
211
|
+
|
|
212
|
+
### Section 11: Assumptions, Constraints, Dependencies & Risks
|
|
213
|
+
|
|
214
|
+
Heading: `"11. Assumptions, Constraints, Dependencies and Risks"`. Source: `queries/` (TBD/assumption flags), transcript "we're assuming"/"we need access to" segments, `as-is/scope.md` constraints.
|
|
215
|
+
|
|
216
|
+
Four H2 subsections, each a table:
|
|
217
|
+
- **11.1 Assumptions** (Assumption | Detail)
|
|
218
|
+
- **11.2 Constraints** (Constraint | Detail) — populate known values; where a value is genuinely unknown, write the document-language equivalent of "Not confirmed" in the Detail cell and add a standalone `==TBD: what to confirm==` paragraph immediately after the table (never a bare "TBD"). Include regulatory, PII, performance/peak-load, scope.
|
|
219
|
+
- **11.3 Dependencies** (Dependency | Type (hard/soft) | Detail) — **the single home for dependencies** (consolidated from the old §2.4). Classify each hard/soft with the responsible system/party.
|
|
220
|
+
- **11.4 Risks** (Risk | Mitigation)
|
|
221
|
+
|
|
222
|
+
---
|
|
223
|
+
|
|
224
|
+
### Section 12: Glossary
|
|
225
|
+
|
|
226
|
+
Heading: `"12. Glossary"`. Source: `entities/` subfolders + abbreviations from transcripts. Keep to terms actually used in this PDD.
|
|
227
|
+
|
|
228
|
+
Table (caption required, columns: Term | Definition). Alphabetical, one row per term.
|
|
229
|
+
|
|
230
|
+
---
|
|
231
|
+
|
|
232
|
+
### Section 13: Next Steps
|
|
233
|
+
|
|
234
|
+
Heading: `"13. Next Steps"`. Source: `queries/open-questions.md` + unresolved dependencies/risks.
|
|
235
|
+
|
|
236
|
+
Table (columns: # | Action item). Typically: confirm unknown vendors/thresholds, validate connectors, load-test, obtain sign-off.
|
|
237
|
+
|
|
238
|
+
---
|
|
239
|
+
|
|
240
|
+
### Appendix A — Process Map & Diagrams
|
|
241
|
+
|
|
242
|
+
Heading: `"Appendix A: Process Map and Diagrams"`.
|
|
243
|
+
|
|
244
|
+
Reference the stage/process map and the integration sequence diagram (Integration Diagram Placeholder if none). The TO-BE map embedded in §4.1 may be cross-referenced here. For BPMN future states, Appendix A must explicitly reference the embedded BPMN TO-BE diagram from §4.1, cite `to-be/process.bpmn`, and note that it is the process model of record.
|
|
245
|
+
|
|
246
|
+
---
|
|
247
|
+
|
|
248
|
+
## Redundancy / Single-Source-of-Truth Rules
|
|
249
|
+
|
|
250
|
+
To prevent the same content appearing in multiple sections (a defect in the source frameworks), each fact has exactly one home; other sections reference it.
|
|
251
|
+
|
|
252
|
+
| Fact | Single home | Referenced (not repeated) by |
|
|
253
|
+
|---|---|---|
|
|
254
|
+
| Actor catalog (all personas) | §7.1 Roles & Personas | Document Control (governance only), §1 |
|
|
255
|
+
| Numeric targets / KPIs | §10 KPIs | §1.3 Expected Value (qualitative), §3.3 Metrics (baselines only) |
|
|
256
|
+
| Current baselines + measurement | §3.3 Metrics | §1.1 (headline figure only) |
|
|
257
|
+
| Dependencies | §11.3 | §2 (pointer only) |
|
|
258
|
+
| BR → stage/task mapping | §9.1 Traceability Matrix | §5 (clean descriptions only) |
|
|
259
|
+
| Per-task automation type / Case work pattern | §4.2.1 task tables | §4.4 (rollup counts only — no restatement) |
|
|
260
|
+
| Transformation reasoning | §4.3 Why/How columns + 1 paragraph | (former standalone "Rationale" section removed) |
|
|
261
|
+
| Per-step decisions and exception handling (recording layout) | §3.2 Decision points / Exceptions | §8.1 AS-IS Handling (step reference only) |
|
|
262
|
+
|
|
263
|
+
If you find yourself copying a table or number into a second section, replace the copy with a one-line cross-reference.
|
|
264
|
+
|
|
265
|
+
---
|
|
266
|
+
|
|
267
|
+
## Content Discipline
|
|
268
|
+
|
|
269
|
+
### Paragraph and list rules
|
|
270
|
+
|
|
271
|
+
- Max 3 sentences per paragraph, max 5 rendered lines.
|
|
272
|
+
- Open each H1/H2 with a 2-3 sentence framing paragraph, then structured content.
|
|
273
|
+
- **Table** preferred for almost everything structured. When in doubt, use a table.
|
|
274
|
+
- **Numbered list** only for ordered procedural steps.
|
|
275
|
+
- **Bulleted list** only for unordered enumerations that don't fit a table.
|
|
276
|
+
- Max 2 levels of nesting; more means a table was right. Never mix bullet styles in one list.
|
|
277
|
+
|
|
278
|
+
### Bolding system and product names
|
|
279
|
+
|
|
280
|
+
Bold on first mention per section via TextRun:
|
|
281
|
+
- Product/system names: **Oleeo**, **SharePoint**, **UiPath Orchestrator**, **Maestro**, etc.
|
|
282
|
+
- Named documents/artifacts: **Plagiarism Tracker**, **Candidate Response Export**, etc.
|
|
283
|
+
- Key acronyms on first use: **RAG**, **PII**, **LLM**, **HITL**, etc.
|
|
284
|
+
|
|
285
|
+
Don't bold: subsequent mentions, person names, generic terms ("candidate", "automation", "agent"), filenames, paths.
|
|
286
|
+
|
|
287
|
+
**§4 special:** bold at the **stage/task** level, not the section level — re-bold per stage/task. Also bold key field names (**Candidate ID**) and folder paths (**/to-process/**); readers land on individual stages.
|
|
288
|
+
|
|
289
|
+
### Italic
|
|
290
|
+
|
|
291
|
+
Italic for external citations ("Process Walkthrough, 17 March 2026"), captions (the `*Figure N: …*` / `*Table N: …*` paragraph after the visual), and foreign/technical terms on first use. Never underline (reads as a hyperlink).
|
|
292
|
+
|
|
293
|
+
### Empty sections
|
|
294
|
+
|
|
295
|
+
Write "Not applicable for this process." Don't delete the section.
|
|
296
|
+
|
|
297
|
+
### Open questions
|
|
298
|
+
|
|
299
|
+
Reflect ambiguity as a `warning` callout: "Open question: {question} (flagged in {source})." Don't paper over gaps.
|
|
300
|
+
|
|
301
|
+
### No paraphrasing away precision
|
|
302
|
+
|
|
303
|
+
If the wiki says "97 candidates withdrawn out of 2,649 referred", keep those exact numbers.
|
|
304
|
+
|
|
305
|
+
### No wiki internals in PDD
|
|
306
|
+
|
|
307
|
+
The PDD is customer-facing. Never put wiki folder names (`entities/`, `as-is/`, `to-be/`), file paths (`as-is/business-rules.md`), or wikilink syntax (`[[…]]`) in rendered PDD content. Cite by source type:
|
|
308
|
+
|
|
309
|
+
| Acceptable | Forbidden |
|
|
310
|
+
|------------|-----------|
|
|
311
|
+
| "Process Walkthrough (17 March 2026)" | `as-is/steps/step-3.md` |
|
|
312
|
+
| "Project Kickoff" | `raw/kickoff-deck` |
|
|
313
|
+
| "SME Clarification" | `queries/open-questions.md` |
|
|
314
|
+
| "Open Question" | `[[concepts/rag-indicator]]` |
|
|
315
|
+
| "Stakeholder Interview" | `entities/people/john-smith` |
|
|
316
|
+
| "Provided Document: Vendor Invoice Sample (12 Aug 2026)" | `as-is/attachments.md`, `/Users/jane/Documents/invoice.xlsx` |
|
|
317
|
+
|
|
318
|
+
If you can't cite cleanly, drop the source column entirely.
|
|
319
|
+
|
|
320
|
+
---
|
|
321
|
+
|
|
322
|
+
## Placeholders for Missing Visuals
|
|
323
|
+
|
|
324
|
+
### Placeholder marker (required)
|
|
325
|
+
|
|
326
|
+
The draft is a markdown `.md`; precede every missing-visual placeholder with a marker comment so the host suppresses it from the exported `.docx` while keeping it visible in the draft viewer.
|
|
327
|
+
|
|
328
|
+
`<!-- doc:placeholder kind="<kind>" -->` — `kind` is one of `screenshot`, `agent-flow-diagram`, `integration-diagram`, `as-is-diagram`, `to-be-diagram`, `sample-data`.
|
|
329
|
+
|
|
330
|
+
The marker binds to the single block immediately after it; emit one marker per placeholder block. A `sample-data` placeholder spans two blocks (intro callout + example table) — mark both, and use a `[!NOTE]` callout (not a bare italic paragraph) for the intro so the marker binds.
|
|
331
|
+
|
|
332
|
+
```
|
|
333
|
+
<!-- doc:placeholder kind="screenshot" -->
|
|
334
|
+
> [!NOTE]
|
|
335
|
+
> **Screenshot Placeholder**
|
|
336
|
+
> Insert screenshot: Oleeo candidate application view showing the three competency answer fields (Section B).
|
|
337
|
+
|
|
338
|
+
<!-- doc:placeholder kind="sample-data" -->
|
|
339
|
+
> [!NOTE]
|
|
340
|
+
> **Sample Data Placeholder**
|
|
341
|
+
> The following is a representative example. Actual data may vary.
|
|
342
|
+
|
|
343
|
+
<!-- doc:placeholder kind="sample-data" -->
|
|
344
|
+
| Candidate ID | Application ID | Application Status | Answer 1 |
|
|
345
|
+
| --- | --- | --- | --- |
|
|
346
|
+
| C12345 | A99887 | Sifted | In my previous role I led a team of six... |
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
### Screenshot Placeholder
|
|
350
|
+
|
|
351
|
+
`callout`, `style: "note"`, `title: "Screenshot Placeholder"`. Text describes exactly what the missing screenshot should show.
|
|
352
|
+
|
|
353
|
+
```json
|
|
354
|
+
{
|
|
355
|
+
"type": "callout",
|
|
356
|
+
"style": "note",
|
|
357
|
+
"title": "Screenshot Placeholder",
|
|
358
|
+
"text": "Insert screenshot: Action Center — Order Review task form showing per-field DU confidence scores and the Approve / Correct & Resubmit / Reject buttons."
|
|
359
|
+
}
|
|
360
|
+
```
|
|
361
|
+
|
|
362
|
+
### Diagram Placeholder
|
|
363
|
+
|
|
364
|
+
`callout`, `style: "note"`. Title is one of: `"AS-IS Diagram Placeholder"`, `"TO-BE Diagram Placeholder"`, `"Agent Flow Diagram Placeholder"`, `"Integration Diagram Placeholder"`. Text describes what the diagram should depict (entry point, stages, decision points, external systems, retry loops, SLA-breach triggers).
|
|
365
|
+
|
|
366
|
+
### Sample Data Placeholder
|
|
367
|
+
|
|
368
|
+
Intro `[!NOTE]` callout titled **Sample Data Placeholder** followed by a small example table (2-3 synthetic rows, caption required). Precede BOTH the callout and the table with `<!-- doc:placeholder kind="sample-data" -->` so both are stripped from the exported `.docx`.
|
|
369
|
+
|
|
370
|
+
```
|
|
371
|
+
<!-- doc:placeholder kind="sample-data" -->
|
|
372
|
+
> [!NOTE]
|
|
373
|
+
> **Sample Data Placeholder**
|
|
374
|
+
> The following is a representative example. Actual data may vary.
|
|
375
|
+
|
|
376
|
+
<!-- doc:placeholder kind="sample-data" -->
|
|
377
|
+
| Customer ID Token | MAC Address | IMEI | Binding Status |
|
|
378
|
+
| --- | --- | --- | --- |
|
|
379
|
+
| TKN-882341 | A4:C3:F0:11:22:33 | 354123456789012 | Confirmed |
|
|
380
|
+
| TKN-882342 | B2:D1:E9:44:55:66 | 354123456789013 | Confirmed |
|
|
381
|
+
```
|
|
382
|
+
|
|
383
|
+
A `*Figure N: …*` caption is valid only as the italic paragraph directly after the image or diagram it captions; the host attaches it to that block. Never write a figure caption with no visual above it: a missing visual is a Placeholder callout next to the stage/step it illustrates.
|
|
384
|
+
|
|
385
|
+
### Screenshot path resolution
|
|
386
|
+
|
|
387
|
+
Wiki screenshots typically live at:
|
|
388
|
+
- `{WikiPath}/raw/screenshots/`
|
|
389
|
+
- `{WikiPath}/raw/recordings/<id>/screenshots/` (per-recording)
|
|
390
|
+
|
|
391
|
+
Embed a screenshot as its own paragraph, `` (alt text required), then one blank line and its caption paragraph `*Figure N: …*` (sequential across the document, not per-section). The path is relative to the PDD draft, computed from `{DraftsDir}` and `{WikiPath}`; never absolute, never base64. Markdown carries no width or height; the host sizes images at Download. Walk both screenshot folders. Embed where files exist; fall back to Screenshot Placeholder. Recording-layout step screenshots use the same image syntax inside the step-table cell, or standalone in a step card, without a caption (§3.2).
|
|
392
|
+
|
|
393
|
+
**AS-IS / TO-BE maps:** do NOT pre-render PNGs. Embed Mermaid source as a `DiagramBlock` for Mermaid-backed routes and a BPMN diagram block for BPMN-backed routes (see "Dialect emission" → "Diagram embedding"), rasterized only at Download. Agent Flow / Integration diagrams stay as Placeholders.
|
|
394
|
+
|
|
395
|
+
### Diagram sizing (AS-IS / TO-BE)
|
|
396
|
+
|
|
397
|
+
Sizing is handled host-side at Download (Mermaid or BPMN fit-to-page); the author embeds only the route-specific diagram source, never a pre-rendered PNG or explicit dimensions.
|
|
398
|
+
|
|
399
|
+
### Image syntax
|
|
400
|
+
|
|
401
|
+
```
|
|
402
|
+

|
|
403
|
+
|
|
404
|
+
*Figure 1: Oleeo candidate view, competency answers (Section B)*
|
|
405
|
+
```
|
|
406
|
+
|
|
407
|
+
---
|
|
408
|
+
|
|
409
|
+
## Hard Rules
|
|
410
|
+
|
|
411
|
+
| Don't | Instead |
|
|
412
|
+
|-------|---------|
|
|
413
|
+
| Use em-dash in header/footer | Pipe `\|` — em-dash mangled on Windows |
|
|
414
|
+
| Render scope as a flat bullet list | 2-column table (In Scope \| Out of Scope) |
|
|
415
|
+
| Expose wiki paths or folder names in PDD content | Cite by source type, or drop the citation |
|
|
416
|
+
| Leave a missing diagram or screenshot blank | Insert the matching Placeholder callout |
|
|
417
|
+
| Invent or reorder H1 blocks | Use the fixed block order; push overflow into H2/tables |
|
|
418
|
+
| Add H4 headings | Bulleted or numbered list instead |
|
|
419
|
+
| Omit `caption` on tables / alt text + caption on standalone images | Template contract violation; fill them in |
|
|
420
|
+
| Duplicate a fact across sections | One home + cross-reference (see Single-Source-of-Truth Rules) |
|
|
421
|
+
|
|
422
|
+
---
|
|
423
|
+
|
|
424
|
+
## Dialect emission
|
|
425
|
+
|
|
426
|
+
When the orchestrator writes the `<process-slug>-PDD.md` draft, it MUST emit this dialect structure. The host parser (step 02) reads these markers to build the staleness manifest and metadata sidecar.
|
|
427
|
+
|
|
428
|
+
### Top-of-file `pdd:doc` marker
|
|
429
|
+
|
|
430
|
+
First line of the file, before any section content:
|
|
431
|
+
|
|
432
|
+
```
|
|
433
|
+
<!-- pdd:doc header="<process name> | Process Definition Document" footer="Confidential | <client name>" client="<client>" author="<author>" date="<DD Month YYYY>" version="<version>" process="<process name>" template="<step layout>" -->
|
|
434
|
+
```
|
|
435
|
+
|
|
436
|
+
Carry the values from the MANDATORY STOP. `process=` is the HUMAN process name (e.g. `Candidate Sifting`), used verbatim by the host as `wikiProcessName` for cover and header/footer display — it cannot derive this from the wiki path. The draft file MUST be named `<process-slug>-PDD.md` where `<process-slug>` is the slugified name (lowercase, hyphenated, alphanumeric, e.g. `candidate-sifting`) so host discovery finds it. NOTE: `process=` (human name) and the filename slug are DIFFERENT strings derived from the same name — never put the slug in `process=`. The host lifts `client`/`author`/`date`/`version` into the sidecar on first read; never write the sidecar directly. `template=` is the §3.2 step layout the draft uses (`step-table` or `step-cards`), written even when §3.2 uses the default layout.
|
|
437
|
+
|
|
438
|
+
### Section anchors
|
|
439
|
+
|
|
440
|
+
Immediately before each section heading (no blank line between anchor and heading):
|
|
441
|
+
|
|
442
|
+
```
|
|
443
|
+
<!-- pdd:section id=<section-slug> sources=<comma-separated wiki paths> reproj=<token> -->
|
|
444
|
+
## Section Heading
|
|
445
|
+
```
|
|
446
|
+
|
|
447
|
+
Rules:
|
|
448
|
+
|
|
449
|
+
- The host derives viewer section navigation from each anchor and its following heading. Do not emit `[TOC]`, manual entries, or navigation UI markup.
|
|
450
|
+
|
|
451
|
+
- **`id`**: short slug from the section-slug reference table below (e.g. `business-context`, `current-state`, `data-model`).
|
|
452
|
+
- **`sources`**: comma-separated wiki-relative paths from the "Wiki source" column of the reference table. Always serialize the mapped path even when that wiki file does not yet exist — NEVER emit `sources=` empty. A section with no current wiki source still declares its intended path so the host can detect when the source appears.
|
|
453
|
+
- For route-specific source-map cells, choose the matching route's path list and serialize only those comma-separated wiki paths. Never serialize route labels or the other route's paths.
|
|
454
|
+
- **`reproj`**: re-projection token. On first generation emit `reproj=g0` for every section. On a re-projection (re-sync, edit, or a section re-composed mid-generation because its `sources=` changed) emit `reproj=g1`, `reproj=g2`, etc. (monotonic per section). Advance the token ONLY when you (re)write the section prose from the wiki — never on an unrelated turn.
|
|
455
|
+
- No raw HTML, no `<script>`, no non-`delegate:` executable content in the draft body.
|
|
456
|
+
|
|
457
|
+
### Section-level action affordances
|
|
458
|
+
|
|
459
|
+
Each section body must include:
|
|
460
|
+
|
|
461
|
+
1. **Refine link** (end of section body, one line):
|
|
462
|
+
|
|
463
|
+
```
|
|
464
|
+
[Refine section](delegate:refine-section?section=<section-slug>)
|
|
465
|
+
```
|
|
466
|
+
|
|
467
|
+
Visible text is exactly `Refine section` (sentence case, no em dash). Do not vary this text — E2E test selectors depend on it.
|
|
468
|
+
|
|
469
|
+
2. **Open-diagram links** (adjacent to the diagram, immediately after the route-specific diagram block):
|
|
470
|
+
|
|
471
|
+
For the AS-IS process diagram section (anchor id `current-state`):
|
|
472
|
+
|
|
473
|
+
```
|
|
474
|
+
[Open AS-IS diagram](delegate:open-diagram?which=as-is&anchor=current-state)
|
|
475
|
+
```
|
|
476
|
+
|
|
477
|
+
For the TO-BE process diagram section (anchor id `target-state`):
|
|
478
|
+
|
|
479
|
+
```
|
|
480
|
+
[Open TO-BE diagram](delegate:open-diagram?which=to-be&anchor=target-state)
|
|
481
|
+
```
|
|
482
|
+
|
|
483
|
+
Use the section's own `pdd:section id=` value as the `anchor=` param. The host resolves the diagram doc-agnostically by `anchor`, never by hardcoded section names. `which=` drives the accessible label only. Visible text is exactly `Open AS-IS diagram` and `Open TO-BE diagram` (sentence case, acronyms uppercase, no em dash). Do not vary these texts.
|
|
484
|
+
|
|
485
|
+
### Diagram embedding
|
|
486
|
+
|
|
487
|
+
For Mermaid-backed routes, copy the entire canonical Mermaid fenced block verbatim: `as-is/diagram.md` for AS-IS and `to-be/diagram.md` for RPA/Case TO-BE. Preserve its opening `diagramFamily` attribute, Mermaid body, and closing fence. Do not extract the body or construct a new fence. Never pre-render to PNG at generation time. An overview-embedded Mermaid block is a legacy live-view fallback, not a PDD source. Example:
|
|
488
|
+
|
|
489
|
+
````
|
|
490
|
+
```mermaid diagramFamily=generic
|
|
491
|
+
flowchart TB
|
|
492
|
+
A[Start] --> B[Step 1] --> C[End]
|
|
493
|
+
```
|
|
494
|
+
|
|
495
|
+
The example uses `generic`; copy the canonical value unchanged when it is another supported family such as `case-design`. Author flows top-to-bottom (`flowchart TB`), not left-to-right. TB fits a portrait `.docx` page and renders the same in the draft viewer and the export.
|
|
496
|
+
````
|
|
497
|
+
|
|
498
|
+
Rasterization for the `.docx` export happens at Download (host-side), not at generation time.
|
|
499
|
+
|
|
500
|
+
For BPMN-backed routes, read the exact XML from the route-specific process source and embed it in a fenced `bpmn` block. Use `as-is/process.bpmn` for an existing supplied AS-IS BPMN and `to-be/process.bpmn` for a BPMN TO-BE. The source may be semantic-only: the draft viewer resolves geometry before rendering. Do not convert the BPMN process to Mermaid, and do not author a duplicate flowchart by hand. Example:
|
|
501
|
+
|
|
502
|
+
````
|
|
503
|
+
```bpmn
|
|
504
|
+
<bpmn:definitions ...>
|
|
505
|
+
...
|
|
506
|
+
</bpmn:definitions>
|
|
507
|
+
```
|
|
508
|
+
|
|
509
|
+
*Figure: BPMN 2.0 process model rendered from `<route>/process.bpmn`.*
|
|
510
|
+
````
|
|
511
|
+
|
|
512
|
+
### Callout types
|
|
513
|
+
|
|
514
|
+
Use typed GFM callouts for callouts in the body:
|
|
515
|
+
|
|
516
|
+
```
|
|
517
|
+
> [!NOTE]
|
|
518
|
+
> This is a note callout.
|
|
519
|
+
|
|
520
|
+
> [!WARNING]
|
|
521
|
+
> This is a warning callout.
|
|
522
|
+
```
|
|
523
|
+
|
|
524
|
+
### P0 gap callouts
|
|
525
|
+
|
|
526
|
+
For Compliance, KPIs, or RACI sections whose wiki source does not exist yet, emit a warning callout (do NOT write "Not applicable") followed by the section's Refine link. This link IS that section's single step-4 Refine link, not an extra one: emit exactly one `[Refine section]` link per section, never two. The callout and the Refine link are one block: a P0-gap section ends with its Refine link exactly like a content-rich section. Never let the callout terminate the section.
|
|
527
|
+
|
|
528
|
+
```
|
|
529
|
+
> [!WARNING]
|
|
530
|
+
> **Needs capture:** <description of what must be captured — e.g. compliance requirements, KPIs, or RACI matrix>. This section will auto-fill when the wiki source is available.
|
|
531
|
+
|
|
532
|
+
[Refine section](delegate:refine-section?section=<section-slug>)
|
|
533
|
+
```
|
|
534
|
+
|
|
535
|
+
The section anchor MUST still declare `sources=<intended wiki path>` (from the source map) even though the source is absent. This is what lets the host detect the source appearing and auto-fill the section.
|
|
536
|
+
|
|
537
|
+
### Section slug reference
|
|
538
|
+
|
|
539
|
+
The `NN-<id>` part-file prefix used by the assembly flow (see `pdd-generation.md` Assembly) follows this table's row order: `NN` is the 1-based index of the anchored ids only (Cover, Document Control, and Table of Contents have no anchor and are NOT part files; the ordered anchored ids start at `business-context` = `01`).
|
|
540
|
+
|
|
541
|
+
| Section | Anchor `id` | Wiki source (from template source map) |
|
|
542
|
+
|---------|-------------|---------------------------------------|
|
|
543
|
+
| Cover | *(no anchor — synthesized by host)* | metadata STOP |
|
|
544
|
+
| Document Control | *(no anchor — synthesized by host)* | metadata STOP + `entities/people/` |
|
|
545
|
+
| Table of Contents | *(no anchor — synthesized for download by host)* | derived |
|
|
546
|
+
| 1. Business Context | `business-context` | `as-is/overview.md`, `as-is/pain-points.md`, `to-be/overview.md`, `to-be/kpis.md`, `to-be/benefits.md` |
|
|
547
|
+
| 2. Scope | `scope` | `as-is/scope.md`, `entities/applications/`, `entities/processes/` |
|
|
548
|
+
| 3. Current State (AS-IS) | `current-state` | Existing: `as-is/overview.md`, the AS-IS artifact of record (`as-is/process.bpmn`, or `as-is/diagram.md` for case/simple-flow captures), `as-is/steps/`, `as-is/metrics.md` (fallback `as-is/volumetrics.md`), `as-is/pain-points.md`; the §3.2 recording layout adds `as-is/business-rules.md`, `as-is/exception-handling.md`, `queries/open-questions.md`; a case capture adds `as-is/stages.md`, `as-is/stages/`, `as-is/attachments.md` (a BPMN capture carries the same sidecar when its elements were given evidence — cite those refs by the same rules) — render the current state per stage from the stage docs (purpose, entry, owners, systems, timing, exceptions), not as a linear step table, and cite each stage's evidence refs (`displayName` + `addedAt`, per the citation rules); New + RPA: `to-be/overview.md`, `to-be/delivery-model.md`; New + BPMN: `to-be/overview.md`, `to-be/bpmn-details.md`; New + Case: `to-be/overview.md`, `to-be/case-details.md` |
|
|
549
|
+
| 4. Future State (TO-BE) | `target-state` | RPA: `to-be/overview.md`, `to-be/diagram.md`, `to-be/stages.md` when present, `to-be/delivery-model.md`, `to-be/steps/`, `to-be/exception-handling.md`, `to-be/benefits.md`; BPMN: `to-be/overview.md`, `to-be/process.bpmn`, `to-be/bpmn-details.md`, `to-be/transformation-decisions.md`, `to-be/participants-and-lanes.md`, `to-be/events-and-triggers.md`, `to-be/activities.md`, `to-be/gateways-and-routes.md`, `to-be/message-and-timer-flows.md`, `to-be/data-objects.md`, `to-be/exception-handling.md`, `to-be/benefits.md`; Case: `to-be/overview.md`, `to-be/diagram.md`, `to-be/case-details.md`, `to-be/transformation-decisions.md`, `to-be/stages/`, `to-be/decisions-and-routes.md`, `to-be/data-and-evidence.md`, `to-be/exception-handling.md`, `to-be/slas.md`, `to-be/personas.md`, `to-be/benefits.md` |
|
|
550
|
+
| 5. Business Rules | `business-rules` | `as-is/business-rules.md`, `to-be/business-rules.md` |
|
|
551
|
+
| 6. Data Model | `data-model` | `entities/artifacts/`, `as-is/data-inputs-outputs.md` |
|
|
552
|
+
| 7. People (7.1 Roles & Personas) | `people` | `entities/people/` |
|
|
553
|
+
| 7.2 RACI | `raci` | `entities/people/` |
|
|
554
|
+
| 8. Exceptions & Error Handling | `exceptions` | `as-is/exception-handling.md`, `to-be/exception-handling.md` |
|
|
555
|
+
| 9. Compliance & Regulatory | `compliance` | `as-is/compliance.md`, `to-be/business-rules.md` |
|
|
556
|
+
| 10. KPIs & Acceptance Criteria | `kpis` | `to-be/kpis.md` |
|
|
557
|
+
| 11. Assumptions, Constraints, Dependencies & Risks | `assumptions-risks` | `queries/`, `as-is/scope.md` |
|
|
558
|
+
| 12. Glossary | `glossary` | `entities/` |
|
|
559
|
+
| 13. Next Steps | `next-steps` | `queries/open-questions.md` |
|
|
560
|
+
| Appendix A | `appendix-a` | derived |
|
|
561
|
+
|
|
562
|
+
The canonical ordered section-id list (the orchestration's section map + completeness gate) is: `business-context`, `scope`, `current-state`, `target-state`, `business-rules`, `data-model`, `people`, `raci`, `exceptions`, `compliance`, `kpis`, `assumptions-risks`, `glossary`, `next-steps`, `appendix-a`. Cover / Document Control / downloaded TOC carry no anchor (host-synthesized from the `pdd:doc` marker).
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
{
|
|
2
|
+
"kind": "progress-presentation",
|
|
3
|
+
"icons": {
|
|
4
|
+
"discovery": "telescope",
|
|
5
|
+
"as-is": "clipboard-list",
|
|
6
|
+
"to-be": "wrench",
|
|
7
|
+
"validate-to-be": "badge-check",
|
|
8
|
+
"architect-process": "workflow",
|
|
9
|
+
"architect-solution": "blocks",
|
|
10
|
+
"handoff": "send",
|
|
11
|
+
"architect": "blocks"
|
|
12
|
+
}
|
|
13
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Recording-first documentation
|
|
2
|
+
|
|
3
|
+
Read from `SKILL.md` → Opening Discovery Router → Recording-first documentation, once its trigger holds.
|
|
4
|
+
|
|
5
|
+
The step-level current-state draft comes first; TO-BE waits.
|
|
6
|
+
|
|
7
|
+
1. **Capture silently** per `as-is-capture.md` and `recording-processing.md`: steps, entities, rules, exceptions, frames, and the validated current map. Questions ride one pre-drawing batch: the capture format (unless the inputs decide it), the source-bounded scope when it applies, map-changing gaps, and the client name when unknown (the metadata ask), and the future state. No Process Snapshot; gaps that would ride it become open items.
|
|
8
|
+
|
|
9
|
+
**Future-state question** — in the same single AskUser call as the rest of the batch, never an extra one. Ask it after the transcripts are read end to end. Recommendation first, labels word for word:
|
|
10
|
+
|
|
11
|
+
> "What should the future state cover?"
|
|
12
|
+
> Options: *Automate it as recorded (Recommended) — the recorded steps run by a robot where it can, with people keeping the judgement calls* · *Automate it, and document process changes*
|
|
13
|
+
|
|
14
|
+
When the recordings mention intended changes, improvements or pain points, the question names them before the options, one short line each with the recording time (`02:10 - approvals take two clicks`); never invent one. Record the answer in `{WikiPath}/raw/screenshots/future-state.md` (`changes: yes` when the label names process changes, else `changes: no`); later turns follow it and never re-ask.
|
|
15
|
+
2. **Readiness items become open items.** The route (Decision 2), the future process, RACI, KPI targets / acceptance criteria, HITL fields and actions, exception state transitions, privacy class and compliance evidence never gate the draft and are not asked. Write each one the recordings do not show to `queries/open-questions.md` with its impact.
|
|
16
|
+
3. **Generate the document** per `pdd-generation.md`; its readiness gate carves out this route. `current-state` uses the recording execution-detail layout in `pdd-template.md`. Content the recordings cannot supply is a standalone `==TBD: reason==` open item in its section (P0 sections: the "Needs capture" callout), never invented future-state content. `target-state` describes the chosen future state, composed from `to-be/overview.md`, which you write first from the captured steps, rules, decisions and exceptions. Content, short: a one- or two-sentence framing; per part of the process, what a robot does and what stays with a person and why (decisions needing judgement, approvals, exception handling), never an invented capability; the trigger and the outputs; and, only when the user chose to document process changes, each change with its reason and source (a recording time, or "user"). A suggestion nobody confirmed is an open item, never a fact; with `changes: no` the section holds no change. No map, no `Open TO-BE diagram` link, no Future Process Review in this draft, `sources=to-be/overview.md`. The route (Case, BPMN or RPA) and the detailed future design stay open items.
|
|
17
|
+
4. **The draft review is the checkpoint** — this route's one checkpoint, in place of the Process Snapshot. One self-review, after assembly (`pdd-generation.md` "On completion"); none before. Surface the draft per "On completion" — the document in the panel is the review body — then one AskUser: *"Confirm / Change / Attach or record more evidence?"*. Changes run the Refinement cascade. Artifact ≠ confirmation: the draft existing, or "looks good" on part of it, confirms nothing. A later session that finds this draft and no future design resumes here, not at a Process Snapshot. `to-be/overview.md` alone is this draft's future-state page, not a future design: with no map, route or detailed `to-be/` pages, Phase 2 is still open.
|
|
18
|
+
5. **On confirmation**, close as the Process Snapshot does (`as-is-capture.md` Closing Phase 1, step 6): `verified` on the confirmed `as-is/` pages, `ba.asIsCaptured`, one closing line. The first ```sf chip offers future-process design, never `Design the solution` — the document holds the outline of a future state, not a design of one. The phase panel stays on `as-is`; this draft never enters `architect-process`.
|
|
19
|
+
6. **Continuing** runs the normal walk from TO-BE (Decision 2, Future Process Review). After that review the first ```sf chip is `Generate the process document`, which replaces this draft through the full readiness gate.
|