bklog-architecture

Map BKLog Web architecture layers and modules for engineers.

88|138|Updated Oct 26, 2023
One-click install
npx skills add https://github.com/TencentBlueKing/bk-monitor --skill bklog-architecture
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bklog-architecture
Source: https://github.com/TencentBlueKing/bk-monitor/tree/main/bklog/web/.ai-shared/skills/bklog-architecture
Command: npx skills add https://github.com/TencentBlueKing/bk-monitor --skill bklog-architecture

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a structured map of BKLog Web architecture to help engineers quickly understand the system's layers, boundaries, and module relationships.

Core Features & Use Cases

  • Layer overview: Visualizes layers such as View, Store, Services, HTTP, and Hooks.
  • Module mapping: Highlights key business modules like retrieve, favorite, manage, and dashboard.
  • Onboarding reference: Serves as a quick guide for architectural reviews and new team members.

Quick Start

Inspect the bklog/web/src/ directory to understand the scope and module layout.

Frequently Asked Questions about bklog-architecture

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How is the BKLog Web frontend architecture structured in Vue and TypeScript?

The BKLog Web frontend architecture is structured into distinct layers including View, Store, Services, HTTP, and Hooks to define clear boundaries and module relationships within the src directory.

What is the best way to map frontend modules like retrieve and dashboard in a Vue project?

Mapping frontend modules like retrieve and dashboard involves documenting their relationships within the architectural layers to provide structural clarity and governance for engineering teams.

How do I prepare for an architectural review of a TypeScript web application's core layers?

Prepare for an architectural review of a TypeScript web application by inspecting the scope and module layout to understand the boundaries and relationships between View, Store, and Services layers.

Do I need external tools to document frontend architecture boundaries and module relationships?

Documenting frontend architecture boundaries and module relationships requires no external tools, as the map solely describes the existing structure, relationships, and governance for architectural reasoning.

Can I use an architecture map to onboard new engineers to a Vue web codebase?

An architecture map can serve as a quick onboarding reference for new engineers to understand the system's layers, boundaries, and core business modules within the Vue web codebase.