record

star 4

Consolidate workflow artifacts (analysis reports, plans, implementation results) into comprehensive project documentation. Updates README, CHANGELOG, CLAUDE docs and stores technical insights in Serena memory. Use after completing implementation to finalize and document completed work with optional git commit/push. Korean triggers: 문서화, 문서 작성, 문서 업데이트, README 작성, CHANGELOG 작성, 변경사항 기록, 릴리즈 노트, 정리해줘, 문서 정리, 커밋해줘, 푸시해줘, 마무리해줘, 완료 처리.

94wogus-quantit By 94wogus-quantit schedule Updated 4/17/2026
play_arrow Run Skill in Manus View GitHub

name: record description: Consolidate workflow artifacts (analysis reports, plans, implementation results) into comprehensive project documentation. Updates README, CHANGELOG, CLAUDE docs and stores technical insights in Serena memory. Use after completing implementation to finalize and document completed work with optional git commit/push. Korean triggers: 문서화, 문서 작성, 문서 업데이트, README 작성, CHANGELOG 작성, 변경사항 기록, 릴리즈 노트, 정리해줘, 문서 정리, 커밋해줘, 푸시해줘, 마무리해줘, 완료 처리. user-invocable: true

Record

⚠️ CRITICAL LANGUAGE POLICY

DEFAULT LANGUAGE: KOREAN (한국어)

ALL outputs, documentation, CHANGELOG entries, and communications MUST be in KOREAN unless explicitly requested otherwise by the user.

  • ✅ README updates: Write in Korean
  • ✅ CHANGELOG entries: Write in Korean
  • ✅ CLAUDE documentation: Write in Korean
  • ✅ Serena memories: Write in Korean
  • ✅ JIRA comments: Write in Korean
  • ✅ User communication: Respond in Korean

Exception: If the user writes in another language, match that language for responses.

This is a MANDATORY requirement. Do NOT default to English.

When to Use This Skill

Use this skill when:

  • Implementation work is complete and needs documentation
  • User requests "문서화해줘", "document this", "update documentation"
  • After execute completes (mandatory for README/CHANGELOG updates)
  • Need to update project README with new features
  • Need to add CHANGELOG entries
  • Multiple workflow artifacts need consolidation
  • Before committing final changes to git
  • As part of release preparation

Typical Workflow Position:

analyze → plan → execute → **record**

⚠️ Important Note: The execute skill only handles code implementation and testing. This skill is responsible for project documentation (README, CHANGELOG, etc.). Run this skill after execute completion to update all documentation.

Overview

This skill provides a 10-phase process to collect all artifacts generated from the workflow and systematically update project documentation:

  1. Discovery & Collection: Find and collect workflow artifacts
  2. README Update: Update project README with features, API, settings, etc.
  3. ARCHITECTURE.md Update: Create or update high-level codebase mental map (matklad pattern)
  4. CHANGELOG Update: Add change history in Keep a Changelog format
  5. CLAUDE Documentation: Update architecture decisions and troubleshooting guides
  6. Serena Memory: Save technical insights to memory
  7. JIRA Issue Update: Summarize implementation completion and add comments to JIRA issue
  8. Additional Docs: Create migration guides, API docs, etc. as needed
  9. Verification: Verify documentation quality and completeness
  10. Cleanup: Clean up workflow artifacts (archive or delete)

Documentation Strategy

Documentation Purpose and Audience

Document Purpose Target Audience Update Timing
README.md Project overview and onboarding New developers On major architecture changes
ARCHITECTURE.md High-level codebase mental map All developers On structural/module-level changes
CLAUDE.md AI work guidelines Claude Code On workflow/convention changes
CHANGELOG.md Detailed change history All developers, PM After all feature implementation/bug fixes
Serena Memory Complex technical patterns Claude Code On 50+ line code changes

Key Principles:

  • Each document has a clear purpose and target audience
  • Avoid duplication and place information in appropriate documents
  • Maintain a maintainable document structure

Workflow: 10-Phase Documentation Process

Phase 0: Task Registration

⚠️ CRITICAL: DO NOT SKIP PHASE 0

Objective: Register all Phases as Tasks to track progress throughout the record workflow.

Register the following Phases in order using TaskCreate:

Task subject activeForm
Phase 1 Branch Validation Validating branch
Phase 2 Discovery and Collection Discovering and collecting artifacts
Phase 3 README Update Updating README
Phase 4 ARCHITECTURE.md Update Updating ARCHITECTURE.md
Phase 5 CHANGELOG Update Updating CHANGELOG
Phase 6 CLAUDE Documentation Update Updating CLAUDE docs
Phase 7 Serena Memory Update Updating Serena memory
Phase 8 JIRA Issue Update Updating JIRA issue
Phase 9 Additional Documentation Writing additional docs
Phase 10 Verification and Quality Check Verifying quality
Phase 11 Cleanup Workflow Artifacts Cleaning up artifacts

Task Tracking Rules:

  • On Phase entry: TaskUpdate(taskId, status: "in_progress")
  • On Phase completion: TaskUpdate(taskId, status: "completed")
  • Phases 1, 2, 10, 11 run sequentially (one at a time)
  • Phases 3-9 run in parallel — launched simultaneously as Task tool calls in Phase 2.5

Phase 1: Branch Validation

📋 Task Tracking: Mark this Phase's Task as in_progress on entry, completed on completion.

MANDATORY REQUIREMENT:

  • DO NOT assume you are on the correct branch
  • ALWAYS verify branch status using the MCP tool below
  • NEVER start documentation (Phase 2) without completing Phase 1

Why this matters:

  • Verifies git branch before committing documentation
  • Ensures documentation updates are in feature branches
  • Prevents accidental commits to protected branches

Objective: Verify that you are working on a feature branch.

Steps:

1. Check Branch Protection Status

Use check_branch_protection MCP tool:

Tool: check_branch_protection
Returns:
  - branch: 현재 브랜치 이름
  - is_protected: 보호 브랜치 여부 (main/master/staging)
  - needs_new_branch: 새 브랜치 생성 필요 여부
  - message: 상태 메시지

2. Branch Decision

  • If is_protected is false: Proceed directly to Phase 2
  • If is_protected is true: Proceed to Step 3

3. Ask User - Branch Action

Use AskUserQuestion tool to provide options:

questions:
  - question: "현재 보호된 브랜치({branch})에서 작업 중입니다. 어떻게 진행할까요?"
    header: "Branch"
    options:
      - label: "새 브랜치 생성 (Recommended)"
        description: "feature 브랜치를 생성하여 안전하게 작업합니다"
      - label: "현재 브랜치에서 계속"
        description: "⚠️ 보호된 브랜치에서 직접 작업합니다 (권장하지 않음)"
  • If "새 브랜치 생성" selected: Proceed to Step 4
  • If "현재 브랜치에서 계속" selected: Display warning and proceed to Phase 2
    • Output: ⚠️ 보호된 브랜치({branch})에서 문서를 작성합니다. 변경사항이 직접 반영됩니다.

4. Ask User - Branch Name

Use AskUserQuestion tool to select branch name:

questions:
  - question: "생성할 브랜치 이름을 선택하세요"
    header: "Name"
    options:
      - label: "feature/{FEATURE_NAME}"
        description: "작업 내용 기반 추천 브랜치 이름"
      - label: "직접 입력"
        description: "원하는 브랜치 이름을 직접 입력합니다"

Branch Name Suggestion Logic:

  • If PLAN/REPORT file exists: Suggest feature/{ID_from_file} format
  • If JIRA ID exists: Suggest feature/JIRA-123 format
  • Otherwise: Suggest feature/record-{YYYYMMDD} format

5. Create Feature Branch

Use create_feature_branch MCP tool:

Tool: create_feature_branch
Args:
  - branch_name: 선택된 또는 입력된 브랜치 이름
Returns:
  - success: 성공 여부
  - branch: 생성된 브랜치 이름
  - message: 결과 메시지

Phase 2: Discovery and Collection

📋 Task Tracking: Mark this Phase's Task as in_progress on entry, completed on completion.

Objective: Find, read, and understand all workflow artifacts.

1A. Find Workflow Artifacts

// Search for all relevant files
Glob({ pattern: "*_REPORT.md" }); // Analysis reports
Glob({ pattern: "*_PLAN.md" }); // Task plans
Glob({ pattern: "*_REVIEW.md" }); // Plan reviews (if any)

// List directory to check for other files
mcp__plugin_serena_serena__list_dir({ relative_path: ".", recursive: false });

1B. Read and Parse Artifacts

For each file found:

Read({file_path: artifactPath})

// Extract key information:
- Problem/feature description
- What was implemented
- Code changes made
- Technical decisions
- Tests added
- Dependencies added/changed
- Breaking changes

1C. Organize Information

// Use sequential thinking to organize
mcp__plugin_seq-think_st__sequentialthinking({
  thought: "Analyzing workflow artifacts to determine documentation structure",
  thoughtNumber: 1,
  totalThoughts: 5,
  nextThoughtNeeded: true
})

// Determine:
- What goes in README (features, usage, API)
- What goes in CHANGELOG (changes by type)
- What goes in CLAUDE docs (decisions, patterns)
- What goes in Serena memory (technical context)

Phase 2.5: Launch Parallel Documentation Tasks

📋 This is a coordination step — not a tracked Task. Launches Phases 3-9 simultaneously.

Objective: After Phase 2 completes, spawn Phases 3-9 as parallel subagents in a single message with 7 Task tool calls.

Prepare Shared Context

Before launching, assemble a context summary from Phase 2 artifacts:

- artifact_paths: list of REPORT/PLAN file paths found
- changes_summary: what was implemented/fixed (from artifacts)
- version: new version string (if applicable)
- jira_id: JIRA issue ID (if found, else empty)
- project_root: absolute path to project root

Launch All 7 Tasks Simultaneously

Call all 7 Task tool calls in a single message (no waiting between calls):

Task(subagent_type=general-purpose, name="phase3-readme"):
  "Execute Phase 3 (README Update) of the wf:record skill.
   Context: {context_summary}
   Instructions: Read SKILL.md Phase 3 section. Mark Phase 3 task in_progress,
   update README.md with new features/API/config, mark completed."

Task(subagent_type=general-purpose, name="phase4-architecture"):
  "Execute Phase 4 (ARCHITECTURE.md Update) of the wf:record skill.
   Context: {context_summary}
   Instructions: Read SKILL.md Phase 4 section. Mark Phase 4 task in_progress,
   create or update ARCHITECTURE.md using matklad pattern, mark completed."

Task(subagent_type=general-purpose, name="phase5-changelog"):
  "Execute Phase 5 (CHANGELOG Update) of the wf:record skill.
   Context: {context_summary}
   Instructions: Read SKILL.md Phase 5 section. Mark Phase 5 task in_progress,
   add new entry to CHANGELOG.md in Keep a Changelog format, mark completed."

Task(subagent_type=general-purpose, name="phase6-claude"):
  "Execute Phase 6 (CLAUDE Documentation Update) of the wf:record skill.
   Context: {context_summary}
   Instructions: Read SKILL.md Phase 6 section. Mark Phase 6 task in_progress,
   update CLAUDE.md with architecture decisions and troubleshooting guides, mark completed."

Task(subagent_type=general-purpose, name="phase7-serena"):
  "Execute Phase 7 (Serena Memory Update) of the wf:record skill.
   Context: {context_summary}
   Instructions: Read SKILL.md Phase 7 section. Mark Phase 7 task in_progress,
   write architecture_decisions/known_issues/code_patterns/dependencies/testing memories, mark completed."

Task(subagent_type=general-purpose, name="phase8-jira"):
  "Execute Phase 8 (JIRA Issue Update) of the wf:record skill.
   Context: {context_summary}, jira_id: {jira_id}
   Instructions: Read SKILL.md Phase 8 section. Skip if no jira_id.
   Mark Phase 8 task in_progress, add JIRA comment, mark completed."

Task(subagent_type=general-purpose, name="phase9-additional"):
  "Execute Phase 9 (Additional Documentation) of the wf:record skill.
   Context: {context_summary}
   Instructions: Read SKILL.md Phase 9 section. Mark Phase 9 task in_progress,
   create migration guide/API docs only if breaking changes exist, mark completed."

Wait and Proceed

After all 7 Tasks return, proceed to Phase 10: Verification.

Phase 3: README Update

📋 Task Tracking: Mark this Phase's Task as in_progress on entry, completed on completion. ⚡ Parallel: Runs as a subagent launched from Phase 2.5.

Objective: Add new features, API, settings, etc. to README.

2A. Find and Read Current README

// Find README
mcp__plugin_serena_serena__find_file({file_mask: "README*", relative_path: "."})

// Read current README
Read({file_path: "README.md"})

// Identify sections:
- Features
- API documentation
- Configuration/Environment variables
- Installation/Setup
- Usage examples
- Dependencies

2B. Prepare Updates

Prepare updates based on content extracted from workflow artifacts:

Features Section:

## Features

### ✨ [New Feature Name] (Added: 2025-01-15)

[Brief description from plan/implementation]

**Key Capabilities:**

- [Capability 1]
- [Capability 2]

**Usage:**
\`\`\`typescript
[Code example]
\`\`\`

API Documentation:

## API Reference

### New Endpoints

#### `POST /api/new-endpoint`

[Description]

**Request:**
\`\`\`json
{
"field": "value"
}
\`\`\`

**Response:**
\`\`\`json
{
"result": "success"
}
\`\`\`

Configuration:

## Configuration

### Environment Variables

| Variable  | Description   | Default   | Required |
| --------- | ------------- | --------- | -------- |
| `NEW_VAR` | [Description] | `default` | Yes      |

2C. Apply README Updates

// Update README sections
Edit({
  file_path: "README.md",
  old_string: "## Features\n[old content]",
  new_string: "## Features\n\n### ✨ New Feature\n...\n\n[old content]",
});

Phase 4: ARCHITECTURE.md Update

📋 Task Tracking: Mark this Phase's Task as in_progress on entry, completed on completion. ⚡ Parallel: Runs as a subagent launched from Phase 2.5.

Objective: Create or update the project's ARCHITECTURE.md — a high-level "mental map" of the codebase for developers.

Design Philosophy (based on matklad's ARCHITECTURE.md):

  • The biggest gap between a newcomer and a core contributor is knowledge of the project's physical structure
  • ARCHITECTURE.md shares this "mental map" at low cost and high value
  • It is a map of the country, NOT a collection of state maps
  • Only include stable, high-level information that changes infrequently
  • Use symbol/module names instead of links (readers can search; links rot)
  • Keep it concise: every regular contributor should read it

4A. Find or Determine ARCHITECTURE.md Applicability

// Look for existing ARCHITECTURE file
mcp__plugin_serena_serena__find_file({
  file_mask: "ARCHITECTURE*",
  relative_path: ".",
});

// Also check if one exists but named differently
Glob({ pattern: "**/ARCHITECTURE*" });

Skip this phase if:

  • No structural/architectural changes were made (e.g., bug fix within existing module)
  • The project is too small to benefit (<1k lines)
  • User explicitly opts out

If ARCHITECTURE.md does not exist yet, create it immediately using the template in 4C. Analyze the current project structure from workflow artifacts and codebase exploration to populate the initial content.

4B. Determine Structural Changes

From workflow artifacts (Phase 2), identify changes relevant to ARCHITECTURE.md:

  • New modules or significant components added
  • Changes to module relationships or dependency direction
  • New architectural invariants or constraints introduced
  • Changes to cross-cutting concerns (logging, error handling, auth, etc.)
  • Renamed or restructured directories

If no structural changes found: Skip update, proceed to Phase 5.

4C. Update or Create Sections

Follow matklad's principles for each section:

Bird's Eye View (조감도):

## Bird's Eye View

[프로젝트가 해결하는 핵심 문제를 2-3문장으로 설명]
[핵심 기술적 접근법 설명]
  • Stable, high-level description of what the project does and how
  • Changes very rarely — only update if the project's fundamental purpose or approach changes

Code Map (코드맵):

## Code Map

### `src/core/`

핵심 비즈니스 로직. `Engine` 타입이 진입점.

### `src/api/`

HTTP API 계층. `src/core/`에 의존하며, 외부 프레임워크 의존성 없음.

### `src/storage/`

데이터 영속성 계층. `Repository` 트레이트가 핵심 추상화.

Rules for Code Map:

  • Cover ONLY top-level modules/directories and their purpose
  • Name important types, traits, functions (readers search by symbol name)
  • Describe relationships between modules ("X depends on Y", "Z is independent")
  • Do NOT describe internal implementation details
  • Keep entries to 1-3 sentences each
  • Verify: items close together in the codemap should be close in the directory structure

Architectural Invariants (아키텍처 불변성):

## Architectural Invariants

- `src/core/`는 외부 프레임워크에 의존하지 않음 (순수 도메인 로직)
- 모든 DB 접근은 `Repository` 인터페이스를 통해서만 수행
- API 응답은 항상 `ApiResponse<T>` 래퍼를 사용

Rules for Invariants:

  • Focus on what is NOT done (absence is harder to notice than presence)
  • State rules that all contributors should know and follow
  • Include the "why" briefly

Cross-cutting Concerns (횡단 관심사):

## Cross-cutting Concerns

### Error Handling

모든 에러는 `AppError` 타입으로 통일. `src/error.rs` 참조.

### Logging

`tracing` 크레이트 사용. 구조화된 로깅 패턴은 `src/logging.rs` 참조.

4D. Quality Verification

Before completing this phase, verify:

- [ ] Concise enough that every regular contributor should read it
- [ ] Only contains stable information (won't change every sprint)
- [ ] Uses symbol/module names instead of line-number links
- [ ] Is a "country map", not a "collection of state maps"
- [ ] Nearby items in Code Map are actually nearby in directory structure
- [ ] Does NOT include implementation details of individual modules

Phase 5: CHANGELOG Update

📋 Task Tracking: Mark this Phase's Task as in_progress on entry, completed on completion. ⚡ Parallel: Runs as a subagent launched from Phase 2.5.

Objective: Add change history to CHANGELOG in Keep a Changelog format.

3A. Find or Create CHANGELOG

// Look for CHANGELOG
mcp__plugin_serena_serena__find_file({
  file_mask: "CHANGELOG*",
  relative_path: ".",
});

// If not found, create new one
Write({
  file_path: "CHANGELOG.md",
  content: `# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/ko/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/lang/ko/).

## [Unreleased]
`,
});

3B. Add New Entry

## [Unreleased] - 2025-01-15

### Added

- [New feature from plan]
- [New API endpoint]
- [New configuration option]

### Changed

- [Updated feature from report]
- [Modified behavior]

### Fixed

- [Bug fix from issue report]
- Resolved: [ISSUE-123] [Issue title]

### Technical Details

- **Dependencies**: [New/updated dependencies]
- **Breaking Changes**: [If any]
- **Related Issues**: [ISSUE-123]

### Testing

- [New tests added]
- [Coverage improvements]

Phase 6: CLAUDE Documentation Update

📋 Task Tracking: Mark this Phase's Task as in_progress on entry, completed on completion. ⚡ Parallel: Runs as a subagent launched from Phase 2.5.

Objective: Add architecture decisions and troubleshooting guides to CLAUDE documentation.

4A. Find CLAUDE Documentation

// Look for CLAUDE docs
mcp__plugin_serena_serena__find_file({
  file_mask: "CLAUDE*",
  relative_path: ".",
});
// Or check .claude/ directory

4B. Update Sections

Architecture Decisions:

## 아키텍처 결정사항

### 2025-01-15 - [Decision Title]

**컨텍스트**: [Why this decision was made]

**결정**: [What was decided]

**영향**: [Impact on codebase]

**대안**: [Alternatives considered]

Troubleshooting Guide:

## 문제 해결 가이드

### [Issue Title]

**증상**: [Problem description from report]

**원인**: [Root cause from analysis]

**해결방법**: [Solution from implementation]

**참고**: [Related files/documentation]

Phase 7: Serena Memory Update

📋 Task Tracking: Mark this Phase's Task as in_progress on entry, completed on completion. ⚡ Parallel: Runs as a subagent launched from Phase 2.5.

Objective: Save technical insights to Serena memory.

5A. Store Technical Context

// Architectural decisions
mcp__plugin_serena_serena__write_memory({
  memory_file_name: "architecture_decisions.md",
  content: `
## 2025-01-15 - [Feature/Fix Name]

### 결정 사항
[Key architectural decisions]

### 근거
[Why these decisions were made]

### 영향받는 컴포넌트
- [Component 1]: [How it's affected]

### 주의사항
[Important considerations]
`,
});

// Known issues and solutions
mcp__plugin_serena_serena__write_memory({
  memory_file_name: "known_issues.md",
  content: `
## 2025-01-15 - [Issue Type]

### 이슈 설명
[Issue description]

### 근본 원인
[Root cause]

### 해결 방법
[How it was fixed]

### 재발 방지
[Prevention measures]

### 관련 코드
- [file.ts:123] - [Description]
`,
});

// Code patterns
mcp__plugin_serena_serena__write_memory({
  memory_file_name: "code_patterns.md",
  content: `
## 2025-01-15 - [Pattern Name]

### 패턴 설명
[Pattern description]

### 사용 사례
[When to use]

### 예제 코드
\`\`\`typescript
[Code example]
\`\`\`

### 주의사항
[Pitfalls or considerations]
`,
});

// Dependencies changelog
mcp__plugin_serena_serena__write_memory({
  memory_file_name: "dependencies_changelog.md",
  content: `
## 2025-01-15 - 의존성 변경

### 추가된 의존성
- \`package-name@version\`: [Why added]

### 업데이트된 의존성
- \`package@old\` → \`@new\`: [Why updated]

### 제거된 의존성
- \`package-name\`: [Why removed]
`,
});

// Testing patterns
mcp__plugin_serena_serena__write_memory({
  memory_file_name: "testing_patterns.md",
  content: `
## 2025-01-15 - [Test Category]

### 테스트 전략
[Testing approach used]

### 테스트 예제
\`\`\`typescript
[Example test code]
\`\`\`

### 테스트 실행
[Commands to run tests]
`,
});

Phase 8: JIRA Issue Update

📋 Task Tracking: Mark this Phase's Task as in_progress on entry, completed on completion. ⚡ Parallel: Runs as a subagent launched from Phase 2.5.

Objective: Summarize implementation completion and add comments to JIRA issue.

⚠️ Important: Execute only when JIRA issue ID can be found in workflow artifacts.

6A. Extract JIRA Issue ID

// From workflow artifacts, extract JIRA issue ID
// Look for patterns like: ISSUE-123, PROJECT-456, etc.
// Common locations:
// - Report file name: ISSUE-123_REPORT.md
// - Plan file "Based On" field
// - Branch name: feature/ISSUE-123-description

// Extract issue ID
const issueId = extractedFromArtifacts; // e.g., "PROJECT-123"

6B. Get Current Issue Status

// Get issue details
mcp__plugin_atlassian_atlassian__jira_get_issue({
  issue_key: issueId,
});

// Check current status:
// - If "In Progress" → Can transition to "Done"
// - If "To Do" → Should be "In Progress" first
// - If "Done" → Just add comment

6C. Prepare Implementation Summary

Write implementation summary based on workflow artifacts:

## 구현 완료 요약

### 변경사항

- ✅ [주요 기능 1]: [설명]
- ✅ [주요 기능 2]: [설명]
- ✅ [버그 수정]: [설명]

### 구현 세부사항

**파일 변경:**

- `src/feature/module.ts`: [변경 내용]
- `src/api/endpoint.ts`: [새 엔드포인트 추가]

**테스트:**

- ✅ 단위 테스트 추가 ([X]개)
- ✅ 통합 테스트 추가 ([Y]개)
- ✅ 모든 테스트 통과

**문서:**

- ✅ README 업데이트
- ✅ CHANGELOG 업데이트
- ✅ API 문서 업데이트

### 관련 문서

- README: [변경된 섹션]
- CHANGELOG: [Unreleased] 섹션
- 기술 문서: [링크 또는 위치]

### 테스트 방법

```bash
# 테스트 실행 명령어
npm test

# 기능 확인 방법
[실행 예제]
```

배포 노트

  • Breaking Changes: [있다면 명시]
  • Dependencies: [새로 추가된 의존성]
  • Configuration: [새 환경 변수나 설정]

#### 6D. Add Comment to JIRA Issue

```typescript
// Add comprehensive comment
mcp__plugin_atlassian_atlassian__jira_add_comment({
  issue_key: issueId,
  comment: `
## ✅ 구현 완료

### 변경사항
- ✅ [주요 기능 1]: [설명]
- ✅ [주요 기능 2]: [설명]

### 구현 세부사항
**파일 변경:**
- \`src/feature/module.ts\`: [변경 내용]

**테스트:**
- ✅ 단위 테스트: [X]개 추가
- ✅ 통합 테스트: [Y]개 추가
- ✅ 모든 테스트 통과

**문서:**
- ✅ README 업데이트 완료
- ✅ CHANGELOG 업데이트 완료

### 관련 커밋
- [commit hash or PR link if available]

### 테스트 방법
\`\`\`bash
npm test
\`\`\`

### 다음 단계
- [ ] 코드 리뷰
- [ ] QA 테스트
- [ ] 프로덕션 배포

---
*문서 업데이트: ${new Date().toISOString().split('T')[0]}*
`
})

6E. Transition Issue Status (Optional)

// Get available transitions
mcp__plugin_atlassian_atlassian__jira_get_transitions({
  issue_key: issueId,
});

// If "Done" transition is available and appropriate:
mcp__plugin_atlassian_atlassian__jira_transition_issue({
  issue_key: issueId,
  transition_id: doneTransitionId, // From available transitions
});

6F. Verification

- ✅ JIRA 이슈 코멘트 추가됨
- ✅ 구현 사항 상세히 기록됨
- ✅ 테스트 정보 포함됨
- ✅ 문서 링크 포함됨
- ✅ 이슈 상태 업데이트됨 (if applicable)

⚠️ Important Notes:

  • Skip this step if JIRA issue ID cannot be found
  • Issue status transition is optional depending on team workflow
  • Do not include sensitive information (passwords, keys, etc.) in comments

Phase 9: Additional Documentation

📋 Task Tracking: Mark this Phase's Task as in_progress on entry, completed on completion. ⚡ Parallel: Runs as a subagent launched from Phase 2.5.

Objective: Create additional documentation as needed.

6A. Migration Guide (if breaking changes)

# Migration Guide: [Old Version] → [New Version]

## 개요

[What changed and why]

## 중단되는 변경사항

### [Change 1]

**변경 전:**
\`\`\`typescript
[Old code]
\`\`\`

**변경 후:**
\`\`\`typescript
[New code]
\`\`\`

**마이그레이션 단계:**

1. [Step 1]
2. [Step 2]

6B. API Documentation (if API changed)

  • Create/update OpenAPI/Swagger spec
  • Generate API docs from code comments
  • Add request/response examples

6C. Architecture Diagrams (if significant changes)

  • Update architecture documentation
  • Create/update diagrams
  • Document component interactions

Phase 10: Verification and Quality Check

📋 Task Tracking: Mark this Phase's Task as in_progress on entry, completed on completion. ⏳ Sequential: Runs only after ALL Phase 3-9 parallel Tasks have completed.

Objective: Verify documentation quality.

8A. Completeness Check

- [ ] README reflects all new features
- [ ] README includes all API changes
- [ ] README has updated configuration
- [ ] ARCHITECTURE.md reflects structural changes (if any)
- [ ] ARCHITECTURE.md is concise and uses symbol names (not links)
- [ ] CHANGELOG has proper entries
- [ ] CHANGELOG follows Keep a Changelog format
- [ ] CLAUDE docs updated with decisions
- [ ] Serena memories saved for key insights
- [ ] JIRA issue updated (if applicable)
- [ ] All code examples are correct
- [ ] All links work properly

8B. Consistency Check

- [ ] Terminology is consistent
- [ ] Version numbers match
- [ ] Dates are correct
- [ ] Formatting is uniform
- [ ] Language (Korean) used consistently

8C. Quality Check

- [ ] Information is clear and concise
- [ ] Technical details are accurate
- [ ] Examples are complete and runnable
- [ ] No sensitive information exposed
- [ ] Cross-references are valid

Phase 11: Cleanup Workflow Artifacts

📋 Task Tracking: Mark this Phase's Task as in_progress on entry, completed on completion.

Objective: Clean up workflow artifacts.

⚠️ Note: The execute skill does not clean up files. This skill cleans up all workflow artifacts.

9A. Identify Remaining Files

// Find remaining artifacts
Glob({ pattern: "*_REPORT.md" });
Glob({ pattern: "*_PLAN.md" });
Glob({ pattern: "*_REVIEW.md" });

9B. Confirm with User

First, display the documentation summary:

문서화가 완료되었습니다.

다음 정보가 저장되었습니다:
- README: [변경된 섹션 목록]
- CHANGELOG: [새 엔트리 추가됨]
- CLAUDE 문서: [업데이트된 섹션]
- Serena 메모리: [저장된 메모리 목록]

남아있는 임시 파일들:
- [REPORT_FILE_1]
- [PLAN_FILE_1]

Then use AskUserQuestion tool to confirm cleanup action:

questions:
  - question: "워크플로우 아티팩트 파일들을 어떻게 처리할까요?"
    header: "Cleanup"
    options:
      - label: "아카이브 (Recommended)"
        description: ".claude/archives/YYYY-MM/ 폴더로 이동합니다"
      - label: "삭제"
        description: "파일을 완전히 제거합니다"
      - label: "유지"
        description: "파일을 그대로 둡니다"

9C. Execute Cleanup

Based on user choice:

Option 1: Delete

rm [files]

Option 2: Archive

mkdir -p .claude/archives/$(date +%Y-%m)
mv [files] .claude/archives/$(date +%Y-%m)/

Option 3: Keep

  • Do nothing

9D. Git Commit and Push

After all documentation updates are complete.

Step 1: Check Git Status

Use git_status MCP tool to check for changes:

Tool: git_status
Returns:
  - staged: 스테이징된 파일 목록
  - modified: 수정된 파일 목록
  - untracked: 추적되지 않는 파일 목록
  - deleted: 삭제된 파일 목록

Step 2: Ask User - Git Commit

If there are uncommitted changes, use AskUserQuestion tool:

questions:
  - question: "커밋되지 않은 변경사항이 있습니다. Git commit을 수행할까요?"
    header: "Commit"
    options:
      - label: "커밋하기 (Recommended)"
        description: "모든 변경사항을 커밋합니다"
      - label: "커밋하지 않기"
        description: "변경사항을 커밋하지 않고 종료합니다"
  • If "커밋하기" selected: Use git_add and git_commit MCP tools
    • Commit message: docs: {FEATURE_NAME} 문서화 완료
    • Output: ✅ 변경사항이 커밋되었습니다
  • If "커밋하지 않기" selected: Skip commit
    • Output: ℹ️ 커밋되지 않은 변경사항이 남아있습니다

Step 3: Ask User - Git Push

After commit (or if there are unpushed commits), use AskUserQuestion tool:

questions:
  - question: "원격 저장소에 push할까요?"
    header: "Push"
    options:
      - label: "Push하기 (Recommended)"
        description: "원격 저장소에 변경사항을 푸시합니다"
      - label: "Push하지 않기"
        description: "로컬에만 유지합니다 (나중에 수동 push)"
  • If "Push하기" selected: Use git_push MCP tool
    • Output: ✅ 원격 저장소에 푸시되었습니다
  • If "Push하지 않기" selected: Skip push
    • Output: ℹ️ 나중에 수동으로 push하세요: git push

When to run: After all documentation updates are complete (after Phase 1-10).

Final Documentation Summary

Present comprehensive summary in Korean:

# 문서화 완료 요약

## 업데이트된 문서

### 📘 README.md

- **Features 섹션**: [추가된 기능 목록]
- **API 섹션**: [추가/변경된 엔드포인트]
- **Configuration 섹션**: [새 환경 변수]
- **Breaking Changes**: [if any]

### 🏗️ ARCHITECTURE.md (if updated)

- **Bird's Eye View**: [변경 여부]
- **Code Map**: [추가/수정된 모듈]
- **Architectural Invariants**: [새로운 불변 규칙]
- **Cross-cutting Concerns**: [변경된 횡단 관심사]

### 📝 CHANGELOG.md

- **버전**: [Unreleased] / [X.Y.Z]
- **Added**: [X개 항목]
- **Changed**: [Y개 항목]
- **Fixed**: [Z개 항목]

### 🤖 CLAUDE Documentation

- **아키텍처 결정**: [새 결정사항]
- **문제해결 가이드**: [새 이슈 해결방법]

### 🧠 Serena Memories

- `architecture_decisions.md`: [저장된 결정사항]
- `known_issues.md`: [저장된 이슈 정보]
- `code_patterns.md`: [저장된 패턴]
- `dependencies_changelog.md`: [의존성 변경]
- `testing_patterns.md`: [테스트 패턴]

### 📋 JIRA Issue (if applicable)

- **이슈**: [ISSUE-123]
- **코멘트 추가**: 구현 완료 사항, 테스트 정보, 문서 링크
- **상태 업데이트**: [In Progress → Done] (if applicable)

### 📚 추가 문서 (if created)

- [Migration Guide]
- [API Documentation]
- [Architecture Diagrams]

## 처리된 워크플로우 아티팩트

### 분석 리포트

- [REPORT files] → 문서에 반영

### 작업 계획

- [PLAN files] → 문서에 반영

### 구현 결과

- [Implementation details] → 모든 문서에 반영

## 정리 현황

### 아카이브됨

- [Files] → .claude/archives/YYYY-MM/

### 삭제됨

- [Files] → 완전히 제거됨

### 유지됨

- [Files] → 참고용으로 보관

## 문서 품질

- ✅ 완성도: 모든 주요 변경사항 문서화
- ✅ 일관성: 용어 및 형식 통일
- ✅ 정확성: 기술적 세부사항 검증
- ✅ 접근성: 명확하고 이해하기 쉬운 설명
- ✅ 유지보수성: 향후 업데이트 용이

## 다음 단계

1. 문서 검토 및 추가 수정
2. Git commit으로 문서 변경사항 저장:
   ```bash
   git add README.md CHANGELOG.md .claude/
   git commit -m "docs: update documentation after implementation"
   ```
  1. 문서 배포 (if applicable)
  2. 팀원들에게 변경사항 공유

---

## Important Guidelines

- **Be thorough**: Don't miss important changes
- **Be accurate**: Verify all technical details
- **Be organized**: Keep documentation structure clean
- **Be consistent**: Use same terminology and formatting
- **Be user-focused**: Write for developers who will read this later
- **Use Korean**: Use Korean for non-code/technical terms (per language policy)
- **Preserve history**: Archive instead of delete when possible
- **Think sequentially**: Use Sequential Thinking to organize information logically

---

## Integration with Workflow

**Typical Usage**:

analyze → plan → execute (code implementation + tests) → record (documentation + Git commit/push)


**When to Use**:
- After `execute` completes, when **documentation and Git operations are needed**
- When CHANGELOG update is required
- When architecture decisions need to be added to CLAUDE docs
- When detailed technical insights need to be saved to Serena memory
- When migration guide or additional API documentation is needed

---

## Error Handling

**If No Artifacts Found**:
- Inform user no documentation to process
- Suggest checking file locations
- Ask if user wants to manually specify files

**If Documentation Files Don't Exist**:
- Offer to create them (README, CHANGELOG, etc.)
- Use standard templates
- Ask user for project-specific information

**If Conflicting Information**:
- Flag conflicts for user review
- Present options for resolution
- Wait for user decision before proceeding

---

## Resources

This skill does not require additional resource directories (scripts/, references/, or assets/). All documentation logic is contained within this SKILL.md file, and the skill relies on Claude's ability to:

1. Use Glob/Read tools to find and read artifacts
2. Use Edit/Write tools to update documentation
3. Use Serena MCP tools for memory storage
4. Use Atlassian MCP tools for JIRA integration
5. Use Sequential Thinking for organization
6. Follow the 10-phase systematic documentation process
7. Maintain comprehensive documentation quality
8. Handle cleanup with user confirmation

The skill is self-contained and ready for use without external dependencies.
Install via CLI
npx skills add https://github.com/94wogus-quantit/wogus-plugin --skill record
Repository Details
star Stars 4
call_split Forks 0
navigation Branch main
article Path SKILL.md
More from Creator
94wogus-quantit
94wogus-quantit Explore all skills →