AgentSkillsCN

assessment-diagram

根据评估结果生成架构图

SKILL.md
--- frontmatter
name: assessment-diagram
description: Generate architecture diagram from assessment results

Assessment Architecture Diagram

This skill generates a simple, clear architecture diagram based on the application assessment results.

When to Use This Skill

Use this skill when you need to:

  • Visualize application architecture after running assessment
  • Understand the high-level structure of the assessed application
  • Get a quick overview of application layers, dependencies, and data flow
  • Share architecture understanding with stakeholders

What This Skill Does

This skill creates a visual architecture diagram by analyzing the codebase:

  1. Analyze Project Structure:

    • Examine project files and directory structure
    • Analyze build files:
      • Java: pom.xml, build.gradle, settings.gradle
      • .NET: *.csproj, *.sln
    • Review configuration files:
      • application.properties, appsettings.json
      • database configs, API configs
    • Scan key source files to understand patterns
    • Extract:
      • Application type and framework
      • Major dependencies and libraries
      • Data access patterns
      • External integrations
      • Technology stack
  2. Analyze Architecture:

    • Identify application layers (UI, Business Logic, Data Access)
    • Detect data storage technologies (databases, caches, file systems)
    • Map external service dependencies
    • Understand component relationships
  3. Generate Diagram:

    • Create a Mermaid C4 or flowchart diagram
    • Focus on high-level architecture, not detailed components
    • Show key layers, dependencies, and data flow
    • Keep it simple and readable
    • Important: Follow GitHub-compatible Mermaid syntax:
      • Avoid special characters (@, #, $, etc.) in arrow labels
      • Use plain text descriptions instead
      • Test rendering compatibility with GitHub
    • Save to .github/appmod/assessment-diagram.md

Input Parameters

  • workspace-path (optional): Path to the project to analyze (defaults to current directory)

How to Use

Prerequisites

  • No special prerequisites required
  • Works with Java and .NET projects only
  • Best used after running assessment skill to understand the context

Triggering Diagram Generation

Simply express the intent to visualize the architecture. Example prompts:

  • "Generate architecture diagram from assessment"
  • "Show me the application architecture"
  • "Create a visual diagram of the assessed application"
  • "Visualize the architecture based on assessment results"

The diagram generation process automatically:

  • Analyzes project files (build files, configs, source structure)
  • Identifies application structure and dependencies
  • Creates a Mermaid diagram showing:
    • Application layers (e.g., Presentation, Business, Data)
    • Key frameworks and libraries
    • Data storage components
    • External service integrations
  • Saves diagram to .github/appmod/assessment-diagram.md

Diagram Output

The generated diagram will be saved to:

  • .github/appmod/assessment-diagram.md

The diagram includes:

  • Application Layers: High-level architectural layers
  • Technology Stack: Key frameworks, libraries, and tools
  • Data Storage: Databases, caches, file systems
  • External Dependencies: Third-party services and APIs
  • Data Flow: How data moves through the system (simplified)

Diagram Style

The diagram is intentionally simple and focused:

Include:

  • High-level application layers
  • Major technology choices
  • Data storage types
  • Key external integrations

Exclude:

  • Detailed class structures
  • Individual components
  • Migration directions (covered in separate planning)
  • Low-level implementation details

Success Criteria

Diagram generation is complete when:

  • ✅ Project structure and files analyzed successfully
  • ✅ Architecture analyzed and key components identified
  • ✅ Mermaid diagram generated with clear, readable structure
  • ✅ Diagram saved to .github/appmod/assessment-diagram.md
  • ✅ Diagram is viewable in markdown preview

Error Handling

Unsupported Project Type:

  • Only supports Java and .NET projects
  • Provide clear message for unsupported project types

Insufficient Architecture Information:

  • Generate a basic diagram from available data
  • Indicate which information is missing or unclear

For any failure, provide clear error messages and next steps.