# netsuite-sdf-project-documentation

> Claude/Codex skill by [@oracle](https://omgskills.com/library/oracle/index.md) · 358 stars · Updated 2026-10-22

Generate enterprise-grade documentation for NetSuite SDF projects. Analyze scripts, object XML files, \`manifest.xml\`, and SuiteQL queries to produce README.md, architecture diagrams (Mermaid/ASCII), deployment guides, and troubleshooting tables. Can integrate with post-deployment documentation workflows when automation (for example, hooks) is available.

Tags: cli, development-kit, javascript, netsuite, nodejs, sdf, sdk, suiteapp, suitecloud, suitecloud-cli, suitecloud-sdk

## Install

```sh
git clone https://github.com/oracle/netsuite-suitecloud-sdk /tmp/netsuite-suitecloud-sdk && ln -s /tmp/netsuite-suitecloud-sdk/packages/agent-skills/netsuite-sdf-project-documentation ~/.claude/skills/netsuite-sdf-project-documentation
```

## From README

NetSuite SDF Documentation Generator Skill Created by: Oracle NetSuite Description Generate comprehensive, enterprise-grade documentation for NetSuite SuiteCloud Development Framework (SDF) projects. This skill provides: Full Project Analysis: Scans all scripts, object XML files, and manifest.xml. Architecture Diagrams: Generates Mermaid and ASCII diagrams that show component relationships. Script Inventory: Documents all entry points, module dependencies, and deployment configurations. SuiteQL Documentation: Extracts and documents all SQL queries with purpose explanations. Deployment Tables: Summarizes script deployments, URLs, and triggers. Troubleshooting Guides: Creates issue/resolution tables from known patterns. Multiple Output Formats: Produces README.md, ARCHITECTURE.md, API.md, and CHANGELOG.md files. Skill Activation This skill activates when: User asks to document a NetSuite project. User asks for README generation.

## Links

- HTML page: https://omgskills.com/skills/oracle/netsuite-suitecloud-sdk/packages/agent-skills/netsuite-sdf-project-documentation/
- GitHub: https://github.com/oracle/netsuite-suitecloud-sdk
- Author: [@oracle](https://omgskills.com/library/oracle/index.md)

## More from this repo

- [netsuite-ai-connector-instructions](https://omgskills.com/skills/oracle/netsuite-suitecloud-sdk/packages/agent-skills/netsuite-ai-connector-instructions/index.md) — NetSuite Intelligence skill — teaches AI the correct tool selection order, output formatting, domain knowledge,...
   - [@oracle](https://omgskills.com/library/oracle/index.md) · 358 stars
- [netsuite-owasp-secure-coding](https://omgskills.com/skills/oracle/netsuite-suitecloud-sdk/packages/agent-skills/netsuite-owasp-secure-coding/index.md) — Platform-agnostic OWASP secure coding practices with JavaScript/Node.js patterns and NetSuite SuiteScript examples.
   - [@oracle](https://omgskills.com/library/oracle/index.md) · 358 stars
- [netsuite-sdf-roles-and-permissions](https://omgskills.com/skills/oracle/netsuite-suitecloud-sdk/packages/agent-skills/netsuite-sdf-roles-and-permissions/index.md) — Used when generating or reviewing NetSuite SDF permission configurations such as customrole XML, script deployment...
   - [@oracle](https://omgskills.com/library/oracle/index.md) · 358 stars