Docs
Document Script — example output
Script documentation with JSDoc
$ nowaikit run docs-script
███╗ ██╗ ██████╗ ██╗ ██╗ █████╗ ██╗ ██╗ ██╗██╗████████╗
████╗ ██║██╔═══██╗██║ ██║ ██╔══██╗██║ ██║ ██╔╝██║╚══██╔══╝
██╔██╗██║██║ ██║██║ █╗ ██║ ███████║██║ █████╔╝ ██║ ██║
██║╚████║██║ ██║██║███╗██║ ██╔══██║██║ ██╔═██╗ ██║ ██║
██║ ╚███║╚██████╔╝╚███╔███╔╝ ██║ ██║██║ ██║ ██╗██║ ██║
╚═╝ ╚══╝ ╚═════╝ ╚══╝╚══╝ ╚═╝ ╚═╝╚═╝ ╚═╝ ╚═╝╚═╝ ╚═╝ ✦
NowAIKit — The #1 AI App for ServiceNow
- Running docs-script in direct mode (ollama)...
✔ Capability completed (0 data points gathered)
# Script Documentation: Request for Script Data
## ⚠️ Missing Script Information
I notice that no script data was provided in your message. To document a ServiceNow script, I need one of the following:
| Required Information | Acceptable Formats |
|---------------------|-------------------|
| Script Include Name | `x_<vendor>_<app>.<Name>` |
| Business Rule Name | `br_<table>_<name>` |
| Client Script Name | `cs_<table>_<name>` |
| Sys_ID | The unique system ID (e.g., `3abc9e818b034b21006a7c5c03354961`) |
| Past Code | Direct copy-paste of the script |
---
## 📋 What I'll Generate Once Provided
Once you provide the script, I will generate:
1. Overview — Purpose, context, trigger, behavior, business value
2. JSDoc Comments — Fully annotated with parameters, returns, exceptions, examples
3. Inputs & Outputs — All parameters, system properties, field modifications, messages
4. Dependencies — Script includes, tables, properties, roles accessed
5. Usage Examples — Practical code snippets for Script Includes
6. Side Effects — Records created/updated/deleted, events fired, notifications
7. Performance — Query analysis, loop risks, caching recommendations
8. Security — Access control, input validation, injection risks
---
## 📤 Please Provide
```
Example submission:
"Document this Script Include: x_myco_utils.AccountValidator"
OR paste the script code directly:
var AccountValidator = Class.prototype.AccountValidator;
...
```
---
Please share the script details and I'll immediately generate the full documentation report! 📝



