AgileBuilder logoAgileBuilder
Back to docs

Team Best Practices

AgileBuilder team usage recommendations

Overview

This document summarizes best practices for using AgileBuilder in a team setting, helping teams efficiently establish and maintain their template systems.

Template Management

1. Start with One Project Type

Don't try to cover all project types from the start.

Recommendations:

  • Start with the most common project type on your team
  • Build one frequently-used template first
  • Expand to other types after validating the approach

Example:

First Template → React Admin Dashboard Template
                    ↓
Second Template → React Frontend App Template (learned from first)
                    ↓
Third Template → Node.js API Template

2. Maintain Templates Alongside Standards

Templates are not isolated file collections—they should be maintained alongside documentation.

Recommendations:

  • Each template should have usage documentation
  • Documentation should explain use cases and limitations
  • Keep a changelog for template updates

3. Clear Naming Conventions

Template naming:

{tech-stack}-{type}-{feature}
Examples: react-admin-antd
          vue-frontend-ts
          node-api-express

Variable naming:

Use camelCase or snake_case
Examples: projectName, useTypeScript, api_base_url

Document Management

1. Document Hierarchy

First Layer: Index Documents (README)
                ↓
Second Layer: Category Documents (Standards, Best Practices)
                ↓
Third Layer: Detailed Documents (Specific standard content)

2. Document Update Process

1. Submit change request
2. Team discussion and approval
3. Update document
4. Review and approval
5. Notify relevant people

3. Linking Documents to Templates

Reference relevant standards documents in the template's README.md.hbs:

## Using This Template

Please read the following standards before proceeding:

- [Code Standards](../../docs/coding-standards.md)
- [API Standards](../../docs/api-spec.md)

AI Integration

1. Unified AI Workflow

Recommendations:

  • Use a unified workflow across the entire team
  • Avoid personal customizations that cause inconsistencies
  • Regularly review workflow effectiveness

2. Standards Before Generation

Order of operations:

1. AI first queries team standards
2. Generate code based on standards
3. Finally verify compliance

3. Monitor AI Generation Quality

  • Regularly check AI generation results
  • Adjust standards or templates based on issues
  • Establish a feedback mechanism

Team Collaboration

1. Assign Owners

Assign an owner to each important template/document:

ResourceOwnerResponsibilities
React Template@ZhangSanMaintain template, update dependencies
Code Standards@LiSiUpdate standards, review changes

2. Change Review Process

Member Submit → Owner Review → Testing → Merge and Release

3. Regular Retrospectives

  • Review template usage monthly
  • Optimize templates and documents based on feedback
  • Deprecate templates that are no longer used

FAQ

Q: What if there are too many templates to manage?

Recommendations:

  • Use tags for categorization
  • Set up template ratings/likes
  • Regularly clean up low-usage templates

Q: What if members don't follow standards?

Recommendations:

  • Improve standards documentation
  • Configure mandatory review
  • Use AI workflows for automatic checks

Q: How do I make AI prioritize team standards?

Recommendations:

  • Force document queries first in the workflow
  • Keep documents up to date regularly
  • Monitor generation result quality

Next Steps