dashboard-domain-specification
A reusable template for defining detailed domain specifications for dashboard projects, including panel requirements, data sources, and interfaces.
- License 许可
- MIT
- 所属仓库
- AG064/OpenSpace
- 最近更新
- 2026-10-08
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- dashboard-domain-specification
- description
- A reusable template for defining detailed domain specifications for dashboard projects, including panel requirements, data sources, and interfaces.
02 资源文件 1
- 其他.skill_id44 B
03 SKILL.md 正文
Dashboard Domain Specification
This skill provides a structured approach to creating detailed domain specifications for dashboard projects. It ensures clarity and completeness by covering panel requirements, data sources, and interfaces.
Steps
-
Define Dashboard Purpose:
- Clearly state the primary goal of the dashboard (e.g., monitoring, analytics, reporting).
-
List Panels:
- Enumerate all panels to be included in the dashboard.
- For each panel, specify:
- Title: Descriptive name of the panel.
- Purpose: What the panel aims to display or achieve.
- Data Sources: Where the data for the panel will come from (e.g., APIs, databases).
- Refresh Rate: How often the data should be updated (e.g., real-time, hourly).
-
Specify Data Sources:
- Detail each data source, including:
- Type: API, database, file, etc.
- Endpoint/Path: URL or path to access the data.
- Authentication: Any required credentials or tokens.
- Data Format: JSON, CSV, etc.
- Detail each data source, including:
-
Define Interfaces:
- Describe the interfaces for interacting with the dashboard:
- User Interface: Layout, navigation, and interactivity.
- Programmatic Interface: APIs or hooks for external systems.
- Describe the interfaces for interacting with the dashboard:
-
Include Examples:
- Provide sample configurations or code snippets for common panels (e.g., time-series charts, tables).
Example
Panel Specification
- title: "Daily Active Users"
purpose: "Display the number of active users per day"
data_sources:
- type: "API"
endpoint: "https://api.example.com/users/daily"
authentication: "Bearer token"
data_format: "JSON"
refresh_rate: "hourly"
Data Source Specification
- name: "User Activity API"
type: "REST API"
endpoint: "https://api.example.com/users"
authentication: "OAuth 2.0"
data_format: "JSON"
Best Practices
- Modularity: Keep panel specifications modular for easy updates.
- Consistency: Use consistent naming conventions for panels and data sources.
- Documentation: Maintain detailed documentation for all components
04 同仓库更多 Skills
write-special-chars-ts-check
Workaround for write_file failures caused by special characters (apostrophes, backticks, template literals) using a Python heredoc script, plus a reliable TypeScript type-checking step that filters output to only the newly-written files to avoid being misled by pre-existing errors.
write-special-chars-readback
Workaround for write_file failures caused by special characters (apostrophes, backticks, template literals) using a Python heredoc script, with mandatory post-write verification via read_file and cleanup of /tmp helper scripts.
write-special-chars-heredoc
Workaround for write_file failures caused by special characters (apostrophes, backticks, template literals) by using a Python heredoc script executed via shell.
worldmonitor-reference
Curated architecture index of the WorldMonitor open-source dashboard. Reference for extracting patterns — vanilla TypeScript, Panel class hierarchy, service layer, CSS grid, API edge functions, refresh scheduler, and 60+ data source integrations.
virtual-list
Implement efficient virtual scrolling for rendering large lists with DOM recycling, chunk-based rendering, and performance optimizations
verify-directory-structure
Diagnose and resolve file access issues by first verifying the directory structure.