Ywc Project Docs

Project Documentation Generator (KR / JA / EN / ZH / ES)

Announce at start: "I'm using the ywc-project-docs skill to generate localized project documentation aligned with the project's docs/ structure."

Generate documentation following the project's docs/ directory structure, naming conventions, and format patterns. Supports Korean, Japanese, English, Chinese, and Spanish.

Rationalization Defense

When tempted to skip a step, check this table first:

| Excuse | Reality | |---|---| | "Language not specified, default to Korean" | Always ask. Default-language assumption produces wrong-language docs that get rewritten. | | "Existing docs/ uses different naming, follow my own pattern" | Match the project's existing naming and structure exactly. Drift creates inconsistent docs over time. | | "Translate Technical terms into local-language equivalents for readability" | Keep API, Backend, Database, etc. in English per the language policy. Over-translation breaks searchability. | | "Doc target unclear, write a generic README" | If target type (Task, Architecture, Spec, Product, Operations) is ambiguous, ask. Generic docs are noise. | | "Reuse content from another doc verbatim" | Cross-reference by relative path. Duplicated content drifts and becomes contradictory. | | "Skip the spec/source link section, content is self-contained" | Always include source/spec references. Docs without source tracing become orphaned over time. | | "English/Chinese/Spanish docs can ignore the same structure" | All supported languages use the same routing, filename, cross-reference, and source-link rules. |

Violating the letter of these rules is violating the spirit. Documentation that does not match repo conventions becomes documentation debt.

Language Selection

Resolve the target language before doing anything else:

1. --lang option present — use it directly, no question needed.

• --lang kr → Korean
• --lang ja → Japanese
• --lang en → English
• --lang zh → Chinese (Simplified)
• --lang es → Spanish

1. No option — ask:

``` 어떤 언어로 작성할까요? / Which language would you like?

1. 한국어 (Korean)
2. 日本語 (Japanese)
3. English
4. 中文 (Chinese, Simplified)
5. Español (Spanish)

`` Accept any of: 1 / 2 / 3 / 4 / 5, Korean / Japanese / English / Chinese / Spanish, 한국어 / 日本語 / 中文 / Español, kr / ja / en / zh / es`, or a sentence containing a language name.

Then apply the corresponding policy from the Language Policy section below.

Context

• Current docs structure: !find docs/ -type f -name "*.md" ! -path "docs/imgs/*" | sort
• Current tasks: !ls docs/plans/ 2>/dev/null; ls docs/todo/ 2>/dev/null

Common Conventions

Directory structure, routing rules, naming conventions, document templates, anti-patterns, folder-specific conventions (Architecture/Specification/Product), and the pre-creation checklist follow the shared reference:

→ [../references/project-docs-structure.md](../references/project-docs-structure.md)

This skill's sole responsibility is generating documentation in the correct language. Structure decisions are delegated to the reference above.

Language Policy

Korean

• Body: Korean prose
• Technical terms: English only — do not transliterate into Hangul
• CLAUDE.md: English only (exception)
• Code blocks: English (variable names and comments)
• Examples:
• ✅ "Database 연결 설정" / ❌ "데이터베이스 연결 설정"
• ✅ "API Endpoint 구현" / ❌ "API 엔드포인트 구현"

Japanese

• Body: Japanese prose
• Technical terms: English only — do not transliterate into Katakana
• CLAUDE.md: English only (exception)
• Code blocks: English (variable names and comments)
• Examples:
• ✅ "Database の接続設定" / ❌ "データベースの接続設定"
• ✅ "API Endpoint の実装" / ❌ "API エンドポイントの実装"

English

• Body: English prose
• Technical terms: English technical vocabulary as written in the source
• CLAUDE.md: English only (exception)
• Code blocks: English (variable names and comments)
• Examples:
• ✅ "Database connection configuration"
• ✅ "API Endpoint implementation"

Chinese (Simplified)

• Body: Simplified Chinese prose
• Technical terms: English only — do not translate core technical terms
• CLAUDE.md: English only (exception)
• Code blocks: English (variable names and comments)
• Examples:
• ✅ "Database 连接配置" / ❌ "数据库连接配置"
• ✅ "API Endpoint 实现" / ❌ "接口端点实现"

Spanish

• Body: Spanish prose
• Technical terms: English only — do not translate core technical terms
• CLAUDE.md: English only (exception)
• Code blocks: English (variable names and comments)
• Examples:
• ✅ "Configuración de conexión Database" / ❌ "Configuración de base de datos"
• ✅ "Implementación de API Endpoint" / ❌ "Implementación de punto final"

Document Structure Template

Follow the shared template structure; localize only the section labels.

Korean labels:

# 제목

설명 (1-2문장)

> **관련 문서**
>
> - [문서 제목](../relative/path.md) — 한 줄 설명

---

## 목차

1. [섹션 1](#1-섹션-1)

---

## 1. 섹션 1

### 1.1 하위 섹션

내용...

Japanese labels:

# タイトル

説明（1-2文）

> **関連ドキュメント**
>
> - [ドキュメントタイトル](../relative/path.md) — 一行説明

---

## 目次

1. [セクション1](#1-セクション1)

---

## 1. セクション1

### 1.1 サブセクション

内容...

English labels:

# Title

Description (1-2 sentences)

> **Related documents**
>
> - [Document title](../relative/path.md) — one-line description

---

## Table of contents

1. [Section 1](#1-section-1)

---

## 1. Section 1

### 1.1 Subsection

Content...

Chinese labels:

# 标题

说明（1-2 句）

> **相关文档**
>
> - [文档标题](../relative/path.md) — 一行说明

---

## 目录

1. [章节 1](#1-章节-1)

---

## 1. 章节 1

### 1.1 子章节

内容...

Spanish labels:

# Título

Descripción (1-2 frases)

> **Documentos relacionados**
>
> - [Título del documento](../relative/path.md) — descripción de una línea

---

## Tabla de contenidos

1. [Sección 1](#1-sección-1)

---

## 1. Sección 1

### 1.1 Subsección

Contenido...

Section structure, table-of-contents insertion conditions, and separator usage follow the shared reference.

Pre-creation Checklist

Before creating any document, confirm:

1. Check for existing documents — A document is "the same topic" when it shares the H1 title OR the routing rules map it to the same target file path. If one exists, update it (do not create a new one).
2. Select directory — Confirm the appropriate directory from the routing rules in the shared reference.
3. Cross-references — If related documents exist, add bidirectional links (new → existing, existing → new).
4. Official vs draft — Content is "finalized" only when the user has approved it OR another committed document already cites it as authoritative; place that in the official folder. Anything still under review or drafted in this session goes to todo/.
5. CLAUDE.md rule — Create documentation only when the user explicitly requests it.

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: yongwoon
• Source: yongwoon/ywc-agent-toolkit
• License: MIT

Install and usage instructions live in the source repository linked above.