project-metadata

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Project Metadata

项目元数据

Overview

概述

This skill provides project initialization and metadata (README.md) generation based on project type. It supports structured initialization for golang and social profile projects.

该技能可根据项目类型提供项目初始化与元数据（README.md）生成服务，支持Golang项目和社交档案项目的结构化初始化。

When to Use

使用场景

Use this skill when:

Creating a new project and need to initialize its structure
Generating or updating README documentation for golang projects
Setting up a social profile workspace

在以下场景中使用该技能：

创建新项目并需要初始化其结构时
为Golang项目生成或更新README文档时
搭建社交档案工作区时

Supported Project Types

支持的项目类型

Type	Structure Reference	Metadata Reference
`default`	N/A (analyzes existing)	`references/default.readme.md`
`golang`	`rules/go-structure.md`	`references/golang.readme.md`
`profile`	`rules/profile-structure.md`	`references/profile.readme.md`

Note: If no project type is specified, the

default

type is used, which analyzes the existing project structure and generates a comprehensive README.md with folder descriptions.

类型	结构参考	元数据参考
`default`	N/A（分析现有结构）	`references/default.readme.md`
`golang`	`rules/go-structure.md`	`references/golang.readme.md`
`profile`	`rules/profile-structure.md`	`references/profile.readme.md`

注意： 如果未指定项目类型，将使用

default

类型，该类型会分析现有项目结构并生成包含文件夹说明的完整README.md。

Project Initialization

项目初始化

Golang Projects

Golang项目

To initialize a golang project structure, follow the guidelines in

rules/go-structure.md

<project-name>/
├── cmd/        # CLI entry points (spf13/cobra)
├── config/     # Configuration and client initialization
├── model/      # Database CRUD operations
├── svc/        # Single domain business logic
├── handler/    # E2E feature orchestration
└── utils/      # Common helper functions

如需初始化Golang项目结构，请遵循

rules/go-structure.md

中的规范：

<project-name>/
├── cmd/        # CLI入口（基于spf13/cobra）
├── config/     # 配置与客户端初始化
├── model/      # 数据库CRUD操作
├── svc/        # 单领域业务逻辑
├── handler/    # 端到端功能编排
└── utils/      # 通用辅助函数

Social Profile Projects

社交档案项目

To initialize a social profile project structure, follow the guidelines in

rules/profile-structure.md

<project-name>/
├── archetype/   # Prototype models for the profile
├── background/  # Profile information and details
├── post/        # Generated posts (YYYYMMDD-<story> naming)
└── assets/      # Non-defined files

如需初始化社交档案项目结构，请遵循

rules/profile-structure.md

中的规范：

<project-name>/
├── archetype/   # 档案原型模型
├── background/  # 档案信息与详情
├── post/        # 生成的帖子（命名格式为YYYYMMDD-<story>）
└── assets/      # 未定义类型的文件

Metadata Generation

元数据生成

Default README (Any Project Type)

默认README（任意项目类型）

To generate README documentation for any project, use the workflow defined in

references/default.readme.md

This is the default workflow when no specific project type is provided. It works for any codebase by:

Identifying Project Type - Detects language and framework from files
Traversing Domain Folders - Analyzes top-level folders (excluding infrastructure)
Analyzing Configuration - Extracts info from package files and configs
Finding Entry Points - Discovers how to run, build, and test
Understanding Purpose - Infers project goals from structure and docs
Generating README - Creates comprehensive documentation

The workflow provides detailed descriptions for each domain folder, helping newcomers understand the project structure quickly.

Read the full reference for detailed steps:

references/default.readme.md

如需为任意项目生成README文档，请使用

references/default.readme.md

中定义的工作流。

当未指定具体项目类型时，这是默认工作流，适用于任何代码库，步骤如下：

识别项目类型 - 从文件中检测语言与框架
遍历领域文件夹 - 分析顶级文件夹（排除基础设施类文件夹）
分析配置信息 - 从包文件与配置中提取信息
查找入口点 - 发现项目的运行、构建与测试方式
明确项目目标 - 从结构与文档中推断项目用途
生成README - 创建完整的项目文档

该工作流会为每个领域文件夹提供详细说明，帮助新成员快速理解项目结构。

查看完整参考文档了解详细步骤：

references/default.readme.md

Golang README

Golang项目README

To generate README documentation for a golang project, use the workflow defined in

references/golang.readme.md

The workflow analyzes:

Folder Structure - Documents key directories and their purposes
Handler List - HTTP/RPC endpoints with methods and descriptions
External Services - RPC, Database, Cache, MQ dependencies
Run/Test Instructions - Build, run, and testing commands

Read the full reference for detailed steps:

references/golang.readme.md

如需为Golang项目生成README文档，请使用

references/golang.readme.md

中定义的工作流。

该工作流会分析以下内容：

文件夹结构 - 记录关键目录及其用途
Handler列表 - HTTP/RPC端点的方法与说明
外部服务依赖 - RPC、数据库、缓存、消息队列等依赖项
运行/测试说明 - 构建、运行与测试命令

查看完整参考文档了解详细步骤：

references/golang.readme.md

Social Profile Metadata

社交档案元数据

To generate README documentation for a social profile project, use the workflow defined in

references/profile.readme.md

The workflow analyzes:

Profile Overview - Name, type, and description
Directory Structure - Standard profile directories
Background Information - Biography, personality, voice from
```
background/
```
Archetype References - Prototype models from
```
archetype/
```
Post List - All posts from
```
post/
```
with dates and content types

Read the full reference for detailed steps:

references/profile.readme.md

如需为社交档案项目生成README文档，请使用

references/profile.readme.md

中定义的工作流。

该工作流会分析以下内容：

档案概述 - 名称、类型与描述
目录结构 - 标准档案目录
背景信息 - 来自
```
background/
```
文件夹的传记、个性与风格
原型参考 - 来自
```
archetype/
```
文件夹的原型模型
帖子列表 -
```
post/
```
文件夹中的所有帖子，包含日期与内容类型

查看完整参考文档了解详细步骤：

references/profile.readme.md

Resources

资源

references/

File	Description
`default.readme.md`	Workflow for default README generation
`golang.readme.md`	Workflow for golang README generation
`profile.readme.md`	Workflow for profile README generation

文件名称	描述说明
`default.readme.md`	默认README生成工作流
`golang.readme.md`	Golang项目README生成工作流
`profile.readme.md`	社交档案项目README生成工作流