AI Guide Introduction
Introduction
This documentation provides guidelines for developing Contentful applications with AI-assisted development tools. These guidelines help developers, and technical teams use AI tools effectively while maintaining high standards of code quality, security, and user experience.
Target audience
This documentation is intended for anyone who is looking to build a Contentful app for the Marketplace or for private use.
Prerequisites
This documentation assumes familiarity with basic Contentful concepts, including:
- Content types and entries — Structures that define and hold content.
- Spaces and environments — Containers for organizing content and workflows.
- App Framework — The development platform for building custom Contentful applications.
Whether building custom Contentful apps, marketplace applications, or integrations, these guidelines help navigate AI-assisted development while ensuring solutions meet Contentful's standards and best practices.
Vision
Our approach to AI-assisted development follows the human-in-the-loop principle, which emphasizes that AI tools augment and enhance human capabilities rather than replace human judgment and expertise.
Key principles
- Human oversight — AI assists development, but humans make all final decisions.
- Code review — Always review and validate AI-generated code before using it.
- Learn and adapt — Use AI as a learning tool to improve skills.
- Context matters — Provide business context that AI tools lack.
Security implications
- Vulnerabilities — AI-generated code may contain vulnerabilities or insecure patterns. Always review and test thoroughly.
- Sensitive information — Be cautious about sharing sensitive information, API keys, or proprietary code with AI tools.
- Outdated packages — Verify that AI-suggested packages are up-to-date and free from known vulnerabilities.
- Authentication flows — Ensure AI-generated authentication follows security best practices.
AI-Assisted Development Tools
This documentation references AI-assisted development in a general sense.
The following principles apply regardless of which tool you use:
- Tool-agnostic approach. Principles apply to any AI development tool. Adapt workflows to your tool's capabilities. Guidelines focus on universal best practices.
- Continuous evolution. AI tools evolve rapidly, and this documentation provides general best practices.
- Risk awareness. AI tools have limitations. Always validate generated code and be mindful of security and compliance requirements.
The choice of tool depends on the team's specific needs, budget, and technical requirements.
