Skip to content
Use › Build Agent › Agentic development on the ServiceNow AI Platform › Building applications
Release: Australia · Updated: 2026-06-24 · Official documentation · View source

Document an application using Build Agent

Generate documentation for the structure, tables, and UI components of an application. Build Agent reads the codebase and creates a README file describing the application architecture.

Before you begin

Role required: admin

About this task

Build Agent processes the application's codebase and produces a README file summarizing the application's tables, sample data, and UI structure. Review the generated documentation for accuracy before sharing or publishing it. AI-generated results may not be accurate in all cases.

Procedure

  1. Navigate to All > App Development > ServiceNow Studio.

    You can also open Build Agent in the ServiceNow IDE if you prefer a more code-centric experience.

    The Build Agent chat panel opens by default in new ServiceNow Studio sessions. If the panel isn't open, select Open Build Agent from the status bar in the lower corner of your browser. You can also select the Sparkle icon

Image omitted: ba-sns-ai-sparkle.png
in the application banner.
Image omitted: sn-studio-access-build-agent.png
If Build Agent isn't open, open it from the status bar in the corner of your browser.

  1. Enter a prompt requesting documentation for the application in the Build Agent chat panel.

    For example, enter Document this app.

  2. Review the response in the Build Agent chat panel.

    Build Agent processes the existing files in the application and generates a README file.

  3. In the File Explorer, open the README file that Build Agent creates.

    The README file displays a description of the application's tables, sample data, and UI page.

Result

The README file is available in the File Explorer for review and distribution.

Parent Topic:Use Build Agent