
project-summary
by jamesodwyerGDS
A full markdown set of design and code documents for designers, engineers and vibe coders to use to adhere to the Global Design System
SKILL.md
name: project-summary description: Update the PROJECT-SUMMARY.md with current features, learnings, and Claude tools used. Triggers on "/project-summary" or requests to "update the project summary".
Project Summary Generator
Update the project summary documentation to reflect the current state of the GDS-MCP project. This skill explores the codebase and generates a comprehensive summary for sharing with the wider team.
Usage
/project-summary
Step-by-Step Workflow
When invoked, follow these steps exactly:
Step 1: Read the Template
Read the template at .claude/skills/resources/project-summary-template.md to understand the required structure.
Step 2: Explore Current State
Gather information about:
- Project Structure - Run
findorlsto understand the current file structure - Documentation Coverage - Count files in
docs/ - Recent Changes - Read
CHANGELOG.mdfor latest updates - Package Info - Read
package.jsonfor available scripts and dependencies - MCP Configuration - Read
mcp-config.jsonandmcp.jsonfor tool configuration - Skills - List skills in
.claude/skills/ - Core Modules - List files in
core/andmcp-server/
Step 3: Calculate Metrics
Count and calculate:
- Total documentation files per folder
- Total lines of documentation (approximate)
- Number of skills available
- Number of MCP tools configured
- Number of core modules
Step 4: Identify Key Features
List all major features by examining:
core/*.js- What generators/transformers existmcp-server/tools/*.js- What MCP tools are available.claude/skills/*/SKILL.md- What skills are definedscripts/*.js- What CLI commands are available
Step 5: Document Claude Tools Used
Identify all Claude/MCP integrations:
- Figma MCP (
mcp.figma.com) - GitMCP (
gitmcp.io) - Custom MCP servers
- Claude Code skills
- Any other integrations
Step 6: Capture Learnings
Extract key learnings from:
CLAUDE.md- Project constraints and patterns- Code comments in
core/files - README documentation
- Architecture decisions evident in code structure
Step 7: Generate Summary
Create/update PROJECT-SUMMARY.md at the repository root following the template structure:
- What It Is - One-paragraph overview
- Key Features Built - Table of features with descriptions
- Current Coverage - Metrics on documentation generated
- Key Claude Tools Used - Table of tools and their purpose
- Key Learnings - Numbered list of insights
- Architecture Diagram - ASCII diagram of system flow
- Quick Start - Commands for team members to get started
- Recent Updates - Last 3-5 changelog entries
Step 8: Update Changelog
Add an entry to CHANGELOG.md:
| Updated PROJECT-SUMMARY.md with current project state | 🟡 Updated | NA | NA | NA |
Step 9: Report
Summarize what was updated:
- New features documented
- Updated metrics
- Any significant changes noted
Output
Single file updated: PROJECT-SUMMARY.md
The summary should be:
- Concise but comprehensive
- Suitable for sharing in team channels (Slack, email)
- Updated with accurate metrics
- Reflecting the current state of the project
Template Reference
Always follow the structure defined in .claude/skills/resources/project-summary-template.md
スコア
総合スコア
リポジトリの品質指標に基づく評価
SKILL.mdファイルが含まれている
ライセンスが設定されている
100文字以上の説明がある
GitHub Stars 100以上
3ヶ月以内に更新がある
10回以上フォークされている
オープンIssueが50未満
プログラミング言語が設定されている
1つ以上のタグが設定されている
レビュー
レビュー機能は近日公開予定です