Skip to main content

AI Dev Kit Feedback Guide

Status: Active
Version: 1.0.0
Last Updated: 2025-12-18

Overview​

Your feedback helps us improve the AI Dev Kit framework. This guide explains how to provide feedback on your installation experience, framework usability, and any issues you encounter.

Why Provide Feedback?​

Your feedback helps us:

  • Improve installation processes
  • Enhance framework usability
  • Fix bugs and issues
  • Identify missing features
  • Improve documentation

We value:

  • Honest, constructive feedback
  • Detailed issue reports
  • Suggestions for improvements
  • Your time and effort

How to Provide Feedback​

After installation, run:

adk feedback

This will guide you through a structured feedback form covering:

  • Installation experience
  • Post-installation state
  • Framework usability
  • Issues encountered

Option 2: GitHub Issue​

Create an issue in the AI Dev Kit repository using the feedback template.

Option 3: Direct Contact​

For critical issues or private feedback, contact the maintainers directly.

Feedback Categories​

1. Installation Experience​

Tell us about your installation:

  • How easy was the installation? (1-5 scale)
  • How long did it take?
  • Were the instructions clear?
  • Did you encounter any errors?
  • What was your overall experience?

Example:

Installation Ease: 4/5
Installation Time: 5 minutes
Instructions: Clear and helpful
Errors: None
Overall: Smooth installation process

2. Post-Installation State​

Describe what your project looks like after installation:

  • What files/directories were created?
  • Is the project structure as expected?
  • Were all expected files present?
  • Was initial configuration successful?

Example:

Files Created:
- docs/project-management/kanban/
- packages/frameworks/
- scripts/
- rw-config.yaml

Structure: Matches documentation
Files: All expected files present
Configuration: Successful

3. Framework Usability​

Share your experience using the framework:

  • How easy is the framework to use? (1-5 scale)
  • Is the documentation clear?
  • Do you understand the workflows?
  • Are the tools intuitive?
  • What is your learning curve?

Example:

Ease of Use: 4/5
Documentation: Clear and comprehensive
Workflows: Easy to understand
Tools: Intuitive and helpful
Learning Curve: Moderate, well-supported

4. Issues Encountered​

Report any problems:

  • Bugs you encountered
  • Error messages you saw
  • Unexpected behavior
  • Missing features
  • Documentation gaps

Example:

Bugs: None encountered
Errors: None
Unexpected Behavior: None
Missing Features: Would like X feature
Documentation Gaps: Need more examples for Y

Feedback Template​

Use this template for structured feedback:

## Installation Experience
- Ease: [1-5]
- Time: [minutes]
- Issues: [description]
- Errors: [error messages]

## Post-Installation State
- Files Created: [list]
- Structure: [description]
- Configuration: [status]

## Framework Usability
- Ease of Use: [1-5]
- Documentation: [rating]
- Workflows: [understanding level]
- Tools: [usability rating]

## Issues Encountered
- Bugs: [list]
- Errors: [list]
- Unexpected Behavior: [description]
- Missing Features: [list]
- Documentation Gaps: [list]

What Happens to Your Feedback?​

1. Collection

  • Your feedback is collected and stored securely
  • Anonymous feedback is welcome (no personal info required)

2. Analysis

  • We analyze feedback for patterns and trends
  • We prioritize issues based on impact
  • We extract actionable insights

3. Integration

  • Feedback becomes Feature Requests (FR) or Bug Reports (BR)
  • Issues are tracked in our Kanban board
  • Improvements are planned and implemented

4. Communication

  • We communicate improvements based on feedback
  • We track feedback resolution
  • We share insights with the community

Tips for Effective Feedback​

Be Specific:

  • Provide detailed descriptions
  • Include error messages
  • Share screenshots if helpful
  • Describe steps to reproduce issues

Be Constructive:

  • Focus on improvements
  • Suggest solutions if possible
  • Provide context
  • Be respectful

Be Timely:

  • Provide feedback soon after installation
  • Report issues as soon as you encounter them
  • Share usability feedback as you use the framework

Privacy and Confidentiality​

We respect your privacy:

  • Anonymous feedback is welcome
  • Personal information is optional
  • Sensitive information is handled securely
  • Feedback is used only for improvement purposes

Questions?​

If you have questions about feedback:

  • Check the documentation
  • Review the FAQ
  • Contact maintainers directly
  • Create a GitHub issue

Thank You!​

Your feedback is invaluable in helping us improve the AI Dev Kit framework. Thank you for taking the time to share your experience!

References​

  • Feedback Mechanism Design: docs/architecture/standards-and-adrs/pre-release-feedback-mechanism-design.md
  • Feedback Template: packages/frameworks/kanban/templates/feedback-template.md
  • GitHub Repository: AI Dev Kit