KB Documentation
Overview
The Knowledge Base Documentation feature lets your team build a living, searchable library of IT procedures directly from the work you're already doing. Articles can be auto-generated from ETW recordings, imported from Markdown files, or written manually. All articles are scoped to the organization and access-controlled per-member.
Access the KB via the Reports page → KB Documentation tab.
Auto-Generating Articles with the Documentation Recorder
The ET Ducky Documentation desktop shortcut launches a recording tool that captures an ETW event stream while you perform a procedure, then uses AI to convert it into a structured knowledge base article.
Recording a Procedure
- Click ET Ducky Documentation in the Start Menu or desktop shortcuts
- Enter an Article Title (e.g. "Clear Firefox cache and cookies")
- Enter a brief Description of what the procedure accomplishes — this is the most important field; it tells the AI which events in the timeline are intentional steps versus background noise
- Click ▶ Start Recording — the recorder captures system-wide ETW events filtered to the application you are interacting with (foreground window tracking automatically excludes background apps)
- Perform the procedure you want to document
- Press Ctrl+Shift+S (or the configured hotkey) at any point to capture a screenshot of the current screen — screenshots are embedded inline in the generated article at the appropriate step
- Click ■ Stop Recording
- Click Generate Article — the recorder sends the event timeline and screenshots to the cloud API, which produces a structured Markdown article
- Review the preview, then click Download Article or Submit to Org KB
Screenshot Capture Hotkey
The screenshot hotkey is configurable and persists between sessions. The default is Ctrl+Shift+S. To change it:
- Click the hotkey label displayed below the Capture button (shown in blue)
- The label changes to "Press new combo…"
- Press any key combination with at least one modifier key (Ctrl, Shift, Alt, or Win)
- The new hotkey is saved immediately to
%AppData%\ETDucky\recorder-settings.json
The hotkey fires system-wide — you do not need to click into the recorder form to trigger a capture. After pressing the hotkey, the recorder minimizes briefly, captures the screen containing the foreground application, then restores.
Browsing and Searching Articles
The KB tab shows a table of all articles in the organization with title, source (Auto-Generated, Manual, Imported), creation date, and last editor. Use the search box to filter by title keyword. Pagination controls appear at the bottom when article count exceeds the page size.
- View — Opens the article in a formatted modal with collapsible sections (Overview, Prerequisites, Procedure, Expected Results)
- Edit — Opens an inline Markdown editor; visible to members with edit permission or org admins
- Delete — Soft-deletes the article; org admin only
- Download .md — Downloads the raw Markdown file
- Permissions — Controls per-member read/edit access; org admin only
- Assign Update — Creates a ticket in a selected team member's queue requesting them to review and update the article; org admin only
Importing Documents
Org admins can import existing Markdown (.md) or plain text (.txt) files directly into the KB. Click Import Document in the KB header to select a file. The content is stored as-is and can be edited after import.
Organization Template
Org admins can upload a formatting template that standardises the structure, section names, tone, and style of all auto-generated articles. When a template is set, the AI mirrors it when generating new articles.
Click Set Template in the KB header (admin only) and select a .md or .txt file. The current template is stored per-organization. Remove it by uploading a new one, or use the API to delete it.
Permissions Model
Each article has an independent permission list controlling which org members can read or edit it. By default, articles inherit org-wide visibility. Org admins always have full access.
| Role | Read | Edit | Delete / Permissions / Assign |
|---|---|---|---|
| Org Admin | ✓ | ✓ | ✓ |
| Member (granted read) | ✓ | — | — |
| Member (granted edit) | ✓ | ✓ | — |
| Member (no grant) | — | — | — |