Project Metadata

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.

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

Supported Project Types

---

Project Initialization

Golang Projects

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

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

---

Metadata Generation

Golang README

To generate README documentation for a golang project, use the workflow defined in references/​golang.readme.md.

The workflow analyzes:

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

Read the full reference for detailed steps:

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:

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

Read the full reference for detailed steps:

references/​profile.readme.md

---

Resources

references/