skills.rest
oracle
oracleOFFICIAL
Explore all skills by this author →
Website𝕏@OracleOSSGitHub

netsuite-sdf-project-documentation

Generate NetSuite SDF project documentation from scripts, XML files, and SuiteQL.

321|103|Updated Nov 19, 2019
Search Tags:#architecture#documentation#deployment#troubleshooting#sdf#netsuite#suiteql
One-click install
npx skills add https://github.com/oracle/netsuite-suitecloud-sdk --skill netsuite-sdf-project-documentation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: netsuite-sdf-project-documentation
Source: https://github.com/oracle/netsuite-suitecloud-sdk/tree/main/packages/agent-skills/netsuite-sdf-project-documentation
Command: npx skills add https://github.com/oracle/netsuite-suitecloud-sdk --skill netsuite-sdf-project-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate comprehensive, enterprise-grade documentation for NetSuite SDF projects by analyzing scripts, object XML files, manifest.xml, and SuiteQL queries to produce README.md, ARCHITECTURE.md, API.md, and CHANGELOG.md.

Core Features & Use Cases

  • Architecture diagrams (Mermaid/ASCII) that map component relationships.
  • Script inventory including entry points, dependencies, and deployment configurations.
  • SuiteQL documentation with purpose explanations and security considerations.
  • Deployment guides and troubleshooting tables derived from known patterns.
  • Multiple output formats: README.md, ARCHITECTURE.md, API.md, CHANGELOG.md for public and internal sharing.

Quick Start

Provide the NetSuite SDF project directory to generate complete documentation artifacts.

Frequently Asked Questions about netsuite-sdf-project-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate documentation for a NetSuite SDF project?▼

To generate NetSuite SDF project documentation, provide your project directory containing scripts, object XML files, manifest.xml, and SuiteQL queries to automatically produce README.md, ARCHITECTURE.md, API.md, and CHANGELOG.md files.

What is the best way to document NetSuite SuiteQL queries and script dependencies?▼

Documenting NetSuite SuiteQL queries and script dependencies is best handled by analyzing code artifacts to extract script inventory, entry points, deployment configurations, and SuiteQL security considerations into structured markdown files.

Can I visualize NetSuite SDF component relationships in architecture diagrams?▼

You can visualize NetSuite SDF component relationships by generating architecture diagrams using Mermaid or ASCII formats that map scripts, objects, and dependencies across the project structure.

How do I create deployment guides and troubleshooting tables for NetSuite SDF projects?▼

Create NetSuite SDF deployment guides and troubleshooting tables by extracting known patterns from project code artifacts, manifest configurations, and script deployment metadata into structured documentation formats.

What project files are required to generate enterprise-grade NetSuite SDF documentation?▼

Generating NetSuite SDF documentation requires project files including SuiteScripts, object XML files, manifest.xml, and SuiteQL queries to extract complete project metadata, architecture mappings, and deployment configurations.

Related Skills

Explore More Content & Communication Skills→
OrderfulOrderful
6

o2c-discovery

Answer Orderful's O2C Discovery Questionnaire using read-only NetSuite SuiteQL queries.

Official
Intermediate
u9401066u9401066

doc-updater

Automate updates to README, CHANGELOG, API, and Memory Bank files.

Community
Basic
majesticlabs-devmajesticlabs-dev
47

mermaid-builder

Generate syntactically valid Mermaid diagrams for flowcharts, sequence, class, state, Gantt, ER, and data lineage.

Official
Advanced
mymx2mymx2
4

repowiki

Generate Mermaid-integrated Markdown documentation from repository architecture analysis.

Community
Advanced