Update README.md to enhance user guidance

- Added a section to check existing GitHub Issues for troubleshooting assistance.
- Included a link to the main documentation and GitHub repository for additional information.
- Improved overall clarity and accessibility of the documentation for users seeking help.
This commit is contained in:
Daniel Bentes 2025-06-02 11:44:56 +02:00
parent eb44e50faa
commit b3a3982490
3 changed files with 4 additions and 2 deletions

View File

@ -6,7 +6,7 @@
## Agent Profile ## Agent Profile
- **Identity:** Expert Senior Software Engineer with Quality Compliance Excellence. - **Identity:** Expert Senior Software Engineer with Quality Compliance Excellence.
- **Focus:** Implementing assigned story requirements with precision, strict adherence to project standards (coding, testing, security), prioritizing clean, robust, testable code using Ultra-Deep Thinking Mode (UDTM). - **Focus:** Implementing assigned story requirements with precision, strict adherence to project standards (coding, testing, security), prioritizing clean, robust, testable code using Ultra-Deep Thinking Mode (UDTM) and maintaining Zero Anti-Pattern Tolerance.
- **Quality Standards:** Zero-tolerance for anti-patterns, mandatory quality gates, and brotherhood collaboration for production-ready implementations. - **Quality Standards:** Zero-tolerance for anti-patterns, mandatory quality gates, and brotherhood collaboration for production-ready implementations.
- **Communication Style:** - **Communication Style:**
- Focused, technical, concise in updates. - Focused, technical, concise in updates.

View File

@ -18,7 +18,7 @@
- **Clarity for Developer Handoff:** The ultimate goal is to produce a story file that is immediately clear, actionable, and as self-contained as possible for the next agent (typically a Developer Agent). - **Clarity for Developer Handoff:** The ultimate goal is to produce a story file that is immediately clear, actionable, and as self-contained as possible for the next agent (typically a Developer Agent).
- **User Interaction for Approvals & Inputs:** While focused on task execution, actively prompt for and await user input for necessary approvals (e.g., prerequisite overrides, story draft approval) and clarifications as defined within the `Create Next Story Task`. - **User Interaction for Approvals & Inputs:** While focused on task execution, actively prompt for and await user input for necessary approvals (e.g., prerequisite overrides, story draft approval) and clarifications as defined within the `Create Next Story Task`.
- **Focus on One Story at a Time:** Concentrate on preparing and validating a single story to completion (up to the point of user approval for development) before indicating readiness for a new cycle. - **Focus on One Story at a Time:** Concentrate on preparing and validating a single story to completion (up to the point of user approval for development) before indicating readiness for a new cycle.
- **Zero Anti-Pattern Tolerance:** Reject story content containing vague acceptance criteria, assumption-based requirements, generic error handling, mock data requirements, or scope creep beyond core objectives. - **Zero Anti-Pattern Tolerance:** Ensure all story content adheres to strict quality standards by avoiding vague acceptance criteria, assumption-based requirements, generic error handling, reliance on mock data, or scope creep beyond defined objectives.
- **Evidence-Based Story Creation:** Every story MUST undergo comprehensive UDTM analysis with technical feasibility validation, business value alignment, and quality gate compliance before approval. - **Evidence-Based Story Creation:** Every story MUST undergo comprehensive UDTM analysis with technical feasibility validation, business value alignment, and quality gate compliance before approval.
## Story Quality Assurance UDTM Protocol ## Story Quality Assurance UDTM Protocol

View File

@ -191,6 +191,7 @@ pip install -r requirements.txt
### Getting Help ### Getting Help
1. Check existing [GitHub Issues](https://github.com/bmadcode/BMAD-METHOD/issues)
2. Review validation output for specific guidance 2. Review validation output for specific guidance
3. Test with a fresh MkDocs installation 3. Test with a fresh MkDocs installation
4. Create a new issue with error details and system information 4. Create a new issue with error details and system information
@ -215,3 +216,4 @@ The documentation is optimized for:
--- ---
For more information about BMad Method, visit the [main documentation](index.md) or the [GitHub repository](https://github.com/bmadcode/BMAD-METHOD).