General guidelines for Build Agent
Use these guidelines to get the most out of Build Agent in your development workflow.
Development guidelines
To maximize Build Agent effectiveness, use the following practices:
- Design before coding: Think through and document the requirements for your application across the data and UI layers, for example using Workflow Studio or Figma.
- Start with a clear plan: Collaborate with Build Agent to define scope, required tables, and metadata types.
- Instruct with context: Write instructions for what you want to achieve with your application using Markdown in your file system, and ask Build Agent to use the file as context for its work.
- Use specific terminology: Treat Build Agent as your development partner. Provide specific, clear instructions using ServiceNow platform terminology such as table names, field names, roles, and artifact types.
- Test early and often: Add sample records, test on the instance, and build ATF tests throughout development.
- Use version control: Use Git for tracking changes and maintaining a clean workspace structure.
- Provide visual context: Give screenshots to Build Agent to troubleshoot UI issues and request changes.
- Extend with third-party libraries: Integrate third-party Node Package Manager (NPM) libraries, such as React JS, for enhanced interfaces.
- Maintain documentation: Keep clear rules and documentation in project folders; use Build Agent to create knowledge base articles.
- Iterate and experiment: Prototype freely, then ask Build Agent for an ideal prompt to recreate the result once your vision is complete.