Skip to content

gmdaos/business-requirements-analyst

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

10 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“‹ Business Requirements Analyst - Claude AI Skill

Complete professional methodology for software and business requirements gathering.

Claude Skill Standards ADR Ready License


🎯 What is this Skill?

Business Requirements Analyst is a Skill for Claude AI that implements a professional requirements gathering methodology, combining:

  • βœ… Business Analysis (BABOK) - Professional business analysis standards.
  • βœ… Design Thinking - User-centered idea validation.
  • βœ… Lean Startup - Rapid vision and MVP validation.
  • βœ… SDD (Specification-Driven Development) - AI-optimized technical documentation using EARS and ADR.

What does it produce?

A master requirements document that includes:

  1. πŸ“Œ Business Vision (Problem, value proposition, KPIs).
  2. πŸ‘₯ Stakeholders & Personas.
  3. πŸ”„ Business Processes (Detailed flows).
  4. πŸ“ Functional Requirements (EARS Syntax) - FR-001, FR-002...
  5. πŸš€ Non-Functional Requirements (Performance, security, scalability).
  6. πŸ“Š Data Model (Auto-ERD) - Entites, relationships, and Mermaid diagrams.
  7. πŸ”Œ Integrations (APIs, external services).
  8. πŸ“ Architecture Decision Records (ADR).
  9. πŸ”— Traceability Matrix (Cumulative tagging from business to code).
  10. βš–οΈ Quality Gates (Automated maturity scoring).
  11. ⚠️ Risks & Assumptions.
  12. πŸ—ΊοΈ Roadmap in Phases (MVP, Phase 2, Phase 3...).

🌟 Professional Enhancement (v2.0)

This version includes advanced automation and traceability features inspired by the aidoc-flow-framework:

  • 🧠 Smart Discovery: Automatically scans provided documents, images, and previous context to avoid repetitive questions.
  • πŸ“ EARS Methodology: Standardized syntax to eliminate ambiguity in functional requirements.
  • οΏ½ ADR Support: Document the "Why" behind critical technical choices.
  • πŸ”— Cumulative Traceability: Embedded tags that create an audit trail from the Business Goal to the implementation code.
  • πŸ“Š Mermaid.js Integration: Automatically generates visual Entity-Relationship Diagrams (ERD).

πŸš€ Installation

Option 1: NPX (Recommended)

npx skills add gmdaos/business-requirements-analyst

Option 2: Manual Installation

In Claude Code:

# Clone the repository
git clone https://github.com/gmdaos/business-requirements-analyst.git

# Copy to your project
cp -r business-requirements-analyst/business-requirements-analyst .agent/skills/

In Claude.ai:

  1. Download the business-requirements-analyst.skill file.
  2. Go to Settings β†’ Features β†’ Skills.
  3. Click on Upload Custom Skill.
  4. Select the .skill file.

In Claude API:

import anthropic

client = anthropic.Anthropic(api_key="your-api-key")

# Upload the Skill
with open("business-requirements-analyst.skill", "rb") as f:
    skill = client.skills.create(file=f)

# Use in conversation
message = client.messages.create(
    model="claude-3-5-sonnet-20241022",
    extra_headers={
        "anthropic-beta": "code-execution-2025-08-25,skills-2025-10-02,files-api-2025-04-14"
    },
    tools=[{
        "type": "code_execution_2025_08_25",
        "container": {
            "skill_id": "business-requirements-analyst"
        }
    }],
    messages=[{
        "role": "user",
        "content": "Help me document my project"
    }]
)

πŸ’‘ Usage

Automatic Activation

The Skill activates automatically when:

  • You mention "requirements gathering".
  • You upload documents or images for analysis.
  • You ask to "document a new project".
  • You request "technical specifications" or "ADR".
  • You need to "validate a business idea".

Conversation Example

πŸ‘€ User: "I need to document my food delivery app for home chefs. Here is a PDF with the concept."

πŸ€– Claude (with active Skill): "Great! I'm your Business Requirements Analyst. To turn your idea into a production-ready blueprint, we'll follow this roadmap: Discovery β†’ Vision β†’ Processes β†’ Specs β†’ Data Model β†’ Roadmap.

I've analyzed the PDF you uploaded. I've already captured the problem statement and the 3 types of users. Let's focus on the gaps:

  1. What specific business rules apply to the delivery fee calculation?
  2. Are there any specific architecture decisions (ADR) we should document regarding the payment gateway? ..."

πŸ“– Live Example: FastBite (Food Delivery)

This is a preview of the quality and structure generated by this setup:


1. Business Vision

Problem: Customers struggle to find diverse local food options with reliable, real-time tracking. Value Proposition: FastBite provides a unified marketplace with a high-performance delivery network and real-time GPS tracking.


2. Business Processes

  1. User places order via App.
  2. System validates payment.
  3. Restaurant accepts and prepares order.
  4. Courier is assigned and delivers.

3. Functional Requirements (EARS Syntax)

ID Requirement EARS Pattern Traceability
FR-01 WHEN the user confirms the order THE System shall initiate the payment process. Event-Driven @brd: BRD.01.01
FR-02 IF the payment fails THEN the System shall notify the user and allow a retry. Unwanted Behavior @brd: BRD.01.05
FR-03 WHILE the courier is in transit THE System shall update the GPS location every 5 seconds. State-Driven @brd: BRD.02.01

4. Data Model (Auto-generated ERD)

erDiagram
    USER ||--o{ ORDER : places
    RESTAURANT ||--o{ ORDER : receives
    ORDER ||--o{ ORDER_ITEM : contains
    ORDER ||--|| PAYMENT : has
    COURIER ||--o{ ORDER : delivers

    USER {
        string id PK
        string name
        string email
    }
    ORDER {
        string id PK
        string status
        float total_amount
        timestamp created_at
    }
    COURIER {
        string id PK
        string vehicle_type
        string current_lat
        string current_lng
    }
Loading

5. Architecture Decisions (ADR)

  • ADR-001: PostgreSQL - Used for transactional integrity and ACID compliance.
  • ADR-002: Stripe Integration - Used for PCI-DSS compliance and split payments.

6. Traceability & Quality Score

  • Maturity Evaluation: 100/100 (APPROVED)
  • Cumulative Tags: Found @brd, @prd, @ears.

πŸ“š Skill Content

Main Files

  • SKILL.md - Core methodology and logic.
  • references/ - Detailed technical deep-dives.
    • ears-methodology.md - Standard for non-ambiguous requirements.
    • traceability-guide.md - Connecting business to implementation code.
    • adr-template.md - Format for recording architectural decisions.
    • process-mapping.md - BPMN and flow techniques.
    • data-modeling.md - Patterns and normalization.
    • use-cases.md - Detailed use cases with templates.
  • assets/ - Templates and resources.
    • requirements-template.md - Master template with Quality Gates.
  • examples/ - Reference projects.
    • food-delivery-app.md - Complete documentation example.

πŸŽ“ Included Methodologies

1. Design Thinking

For idea validation and discovery:

  • Empathize with users.
  • Define the problem.
  • Ideate solutions.
  • Prototype and test.

2. Business Analysis (BABOK)

For professional documentation:

  • Business requirements.
  • Functional & Non-Functional requirements.
  • Business rules.
  • Stakeholders and processes.

3. Lean Startup

For quick vision and validation:

  • Business Model Canvas.
  • MVP (Minimum Viable Product) definition.
  • Key metrics.

πŸ“– Use Cases

βœ… Ideal for:

  • πŸš€ Startups - Validate and document business ideas.
  • πŸ’Ό Consultants - Create professional specs for clients.
  • πŸ‘¨β€πŸ’» Developers - Understand scope before quoting.
  • 🏒 Product Managers - Document product roadmaps.
  • πŸ’° Investors - Evaluate project feasibility.

πŸ“‹ Project Types:

  • E-commerce / Marketplaces
  • SaaS / Web Platforms
  • Mobile Apps
  • Enterprise Systems (ERP, CRM)
  • APIs and Microservices

🌐 Compatibility & Setup

This Skill is designed to be platform-agnostic and works with any AI, Agent, or IDE that supports the .agent/skills (or similar) framework.

Global Setup

  1. Clone this repository.
  2. Link the business-requirements-analyst folder to your environment's skill or agent directory (usually .agent/skills/ or .agent/workflows/).

Specific Implementation Examples:

πŸ€– Claude Code (Terminal)

  • Status: Fully Supported.
  • Ensure your project has the .agent/skills/ structure and the folder is present there.

πŸ’¬ Claude.ai (Web Interface)

  • Status: Pro, Max, Team, or Enterprise plan required.
  • Enable Code Execution in your profile settings to allow the agent to read the methodology.

πŸ”Œ AI-Ready IDEs & APIs

  • Status: Compatible with any system supporting Anthropic Beta headers:
    • code-execution-2025-08-25
    • skills-2025-10-02
    • files-api-2025-04-14

🀝 Contributing

Contributions are welcome!

  1. Fork the repository.
  2. Create a branch: git checkout -b feature/new-feature.
  3. Commit changes: git commit -m 'Add new feature'.
  4. Push: git push origin feature/new-feature.
  5. Open a Pull Request.

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.


πŸ™ Credits

Developed by Gabriel Mayon

Based on:

  • BABOK (Business Analysis Body of Knowledge)
  • Design Thinking (IDEO, Stanford d.school)
  • Lean Startup (Eric Ries)
  • EARS (Easy Approach to Requirements Syntax)

πŸ“ž Support


πŸ”— Useful Links

⭐ If this Skill was useful, give it a star on GitHub!

About

Professional business requirements analysis methodology for Claude AI - BABOK, Design Thinking, complete documentation templates

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors