ywc-project-docs

name: ywc-project-docs description: >- (ywc) Use when the user wants to create or update human-facing docs/ material in Korean or Japanese, such as Task, Architecture, Specification, Product, or operational guide documents. Triggers: "문서 작성", "문서 만들어", "문서 추가해", "한국어 문서", "일본어 문서", "document this", "write a doc", "add to docs/", "ドキュメント作成", "ドキュメントを書いて", "文書作成". Do not use for code comments, root README changes, English-only documentation, project folder-layout design (use ywc-project-scaffold), implementation tasks (use ywc-task-generator), or domain vocabulary docs (use ywc-ubiquitous-language).

Project Documentation Generator (KR / JA)

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

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

Rationalization Defense

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

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
2. No option — ask:

   어떤 언어로 작성할까요? / Which language would you like?
   
     1. 한국어 (Korean)
     2. 日本語 (Japanese)
   

   Accept any of: 1 / 2, Korean / Japanese, 한국어 / 日本語, kr / ja, 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

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 エンドポイントの実装"

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 サブセクション

内容...

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 — If a document on the same topic already 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 — Place pre-finalized content in todo/; place finalized content in the official folder.
5. CLAUDE.md rule — Create documentation only when the user explicitly requests it.

Output Format

Return the created or updated documentation path and a short report:

Status: <DONE | DONE_WITH_CONCERNS | BLOCKED | NEEDS_CONTEXT>
Document: <path created or updated>
Summary: <what changed and why>
Cross-links: <added / updated / not applicable>
Validation: <checks performed before writing>
Next action: <follow-up or "none">

Validation

Before finalizing, confirm that no duplicate document should have been updated instead, the directory matches routing rules, cross-references were considered, official vs draft placement is correct, and the user explicitly requested documentation creation.