@design-ai/cli 4.55.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/plugin.json +164 -0
- package/AGENTS.ko.md +126 -0
- package/AGENTS.md +182 -0
- package/CHANGELOG.md +6883 -0
- package/CLAUDE.md +39 -0
- package/LICENSE +21 -0
- package/README.ko.md +245 -0
- package/README.md +277 -0
- package/agents/README.md +14 -0
- package/agents/a11y-reviewer.md +121 -0
- package/agents/component-architect.md +57 -0
- package/agents/design-critic.md +46 -0
- package/agents/token-extractor.md +63 -0
- package/cli/bin/design-ai-mcp.mjs +6 -0
- package/cli/bin/design-ai.mjs +40 -0
- package/cli/commands/audit.mjs +111 -0
- package/cli/commands/check.mjs +226 -0
- package/cli/commands/doctor.mjs +141 -0
- package/cli/commands/examples.mjs +58 -0
- package/cli/commands/help.mjs +271 -0
- package/cli/commands/install.mjs +161 -0
- package/cli/commands/learn.mjs +1871 -0
- package/cli/commands/list.mjs +143 -0
- package/cli/commands/mcp.mjs +27 -0
- package/cli/commands/pack.mjs +211 -0
- package/cli/commands/prompt.mjs +199 -0
- package/cli/commands/route.mjs +247 -0
- package/cli/commands/search.mjs +60 -0
- package/cli/commands/show.mjs +52 -0
- package/cli/commands/site.mjs +558 -0
- package/cli/commands/status.mjs +161 -0
- package/cli/commands/uninstall.mjs +119 -0
- package/cli/commands/update.mjs +184 -0
- package/cli/commands/version.mjs +94 -0
- package/cli/commands/workspace.mjs +176 -0
- package/cli/lib/brief.mjs +52 -0
- package/cli/lib/check.mjs +642 -0
- package/cli/lib/dispatch.mjs +109 -0
- package/cli/lib/doctor.mjs +505 -0
- package/cli/lib/examples.mjs +258 -0
- package/cli/lib/exec.mjs +63 -0
- package/cli/lib/help-flags.mjs +5 -0
- package/cli/lib/learn.mjs +3694 -0
- package/cli/lib/log.mjs +47 -0
- package/cli/lib/mcp-server.mjs +426 -0
- package/cli/lib/output.mjs +101 -0
- package/cli/lib/pack.mjs +599 -0
- package/cli/lib/paths.mjs +63 -0
- package/cli/lib/prompt.mjs +603 -0
- package/cli/lib/route.mjs +740 -0
- package/cli/lib/search.mjs +158 -0
- package/cli/lib/show.mjs +161 -0
- package/cli/lib/signals.mjs +2337 -0
- package/cli/lib/site.mjs +6617 -0
- package/cli/lib/skill-proposals.mjs +2046 -0
- package/cli/lib/suggest.mjs +66 -0
- package/cli/lib/workspace.mjs +1056 -0
- package/commands/README.md +25 -0
- package/commands/component-spec.md +34 -0
- package/commands/conversational.md +44 -0
- package/commands/design-from-brief.md +141 -0
- package/commands/design-review.md +62 -0
- package/commands/document-from-brief.md +47 -0
- package/commands/extract-tokens.md +38 -0
- package/commands/game-ui.md +40 -0
- package/commands/illustration.md +37 -0
- package/commands/iterate.md +167 -0
- package/commands/motion-design.md +54 -0
- package/commands/palette-from-brand.md +50 -0
- package/commands/print.md +49 -0
- package/commands/slide-deck.md +46 -0
- package/commands/spatial.md +47 -0
- package/commands/stability-review.md +74 -0
- package/commands/video.md +42 -0
- package/commands/website-improvement.md +77 -0
- package/docs/AGENT-DEVELOPMENT.md +658 -0
- package/docs/AI-LEARNING.md +429 -0
- package/docs/AIDER-INTEGRATION.md +224 -0
- package/docs/ARCHITECTURE.ko.md +183 -0
- package/docs/ARCHITECTURE.md +105 -0
- package/docs/CODEX-INTEGRATION.md +311 -0
- package/docs/COMPANY-WEBSITE-DOGFOOD.ko.md +144 -0
- package/docs/COMPANY-WEBSITE-DOGFOOD.md +150 -0
- package/docs/COMPANY-WEBSITE-INTAKE-TEMPLATE.ko.md +153 -0
- package/docs/COMPANY-WEBSITE-INTAKE-TEMPLATE.md +154 -0
- package/docs/CONTRIBUTING.ko.md +203 -0
- package/docs/CONTRIBUTING.md +242 -0
- package/docs/CURSOR-INTEGRATION.md +220 -0
- package/docs/DISTRIBUTION.ko.md +248 -0
- package/docs/DISTRIBUTION.md +253 -0
- package/docs/DOGFOOD-FINDINGS.md +180 -0
- package/docs/DOGFOOD-V4-FINDINGS.md +139 -0
- package/docs/DOGFOOD-V4-MKDOCS-FINDINGS.md +233 -0
- package/docs/DOGFOOD-V4-NPM-FINDINGS.md +157 -0
- package/docs/DOGFOOD-V4-VSCODE-FINDINGS.md +135 -0
- package/docs/FIGMA-INTEGRATION.md +222 -0
- package/docs/MCP-INTEGRATION.md +243 -0
- package/docs/MIGRATION-v4.md +121 -0
- package/docs/PLUGIN-PACKAGING.md +240 -0
- package/docs/PRODUCT-READINESS.md +66 -0
- package/docs/QUICKSTART.ko.md +178 -0
- package/docs/QUICKSTART.md +179 -0
- package/docs/RELEASE-CHECKLIST.md +292 -0
- package/docs/ROADMAP.md +19495 -0
- package/docs/SESSION-LOG.md +940 -0
- package/docs/TOKEN-SYNC.md +237 -0
- package/docs/USING.ko.md +206 -0
- package/docs/USING.md +218 -0
- package/docs/WEBSITE-IMPROVEMENT.ko.md +75 -0
- package/docs/WEBSITE-IMPROVEMENT.md +89 -0
- package/docs/announcements/README.md +56 -0
- package/docs/announcements/dev-to-korea.md +206 -0
- package/docs/announcements/hashnode-post.ko.md +232 -0
- package/docs/announcements/okky-post.ko.md +158 -0
- package/docs/announcements/press-kit.md +101 -0
- package/docs/announcements/reddit-r-korea.md +196 -0
- package/docs/announcements/show-hn.md +114 -0
- package/docs/announcements/twitter-thread.md +255 -0
- package/docs/external-status.md +34 -0
- package/docs/integrations/aider-walkthrough.ko.md +275 -0
- package/docs/integrations/aider-walkthrough.md +274 -0
- package/docs/integrations/codex-walkthrough.ko.md +297 -0
- package/docs/integrations/codex-walkthrough.md +297 -0
- package/docs/integrations/cursor-walkthrough.ko.md +281 -0
- package/docs/integrations/cursor-walkthrough.md +284 -0
- package/docs/integrations/design-ai-mcp-server.md +169 -0
- package/docs/integrations/figma-mcp.md +149 -0
- package/docs/integrations/github-mcp.md +178 -0
- package/docs/integrations/linear-mcp.md +215 -0
- package/docs/integrations/notion-mcp.md +174 -0
- package/docs/integrations/sdk-walkthrough.ko.md +375 -0
- package/docs/integrations/sdk-walkthrough.md +375 -0
- package/docs/integrations/slack-mcp.md +208 -0
- package/docs/integrations/vscode-walkthrough.ko.md +202 -0
- package/docs/integrations/vscode-walkthrough.md +205 -0
- package/docs/requirements.txt +16 -0
- package/docs/site-overrides/extra.css +83 -0
- package/docs/site-overrides/favicon.svg +4 -0
- package/docs/site-overrides/logo.svg +10 -0
- package/docs/site-overrides/main.html +18 -0
- package/docs/website-console/app.js +2540 -0
- package/docs/website-console/index.html +24 -0
- package/docs/website-console/styles.css +975 -0
- package/examples/README.md +252 -0
- package/examples/cases/dogfood-v4-korean-hr-onboarding.md +356 -0
- package/examples/component-accordion-actions.md +153 -0
- package/examples/component-accordion-details.md +147 -0
- package/examples/component-accordion-summary.md +180 -0
- package/examples/component-accordion.md +229 -0
- package/examples/component-account-card.md +284 -0
- package/examples/component-address-input.md +260 -0
- package/examples/component-affix.md +190 -0
- package/examples/component-alert-dialog.md +210 -0
- package/examples/component-alert-title.md +77 -0
- package/examples/component-alert.md +192 -0
- package/examples/component-amount-input.md +278 -0
- package/examples/component-anchor.md +198 -0
- package/examples/component-app-bar.md +249 -0
- package/examples/component-aspect-ratio.md +156 -0
- package/examples/component-auto-complete.md +199 -0
- package/examples/component-avatar-group.md +170 -0
- package/examples/component-avatar.md +191 -0
- package/examples/component-back-top.md +123 -0
- package/examples/component-backdrop.md +148 -0
- package/examples/component-badge.md +181 -0
- package/examples/component-banner.md +237 -0
- package/examples/component-biometric-gate.md +281 -0
- package/examples/component-blockquote.md +153 -0
- package/examples/component-border-beam.md +207 -0
- package/examples/component-bottom-navigation.md +226 -0
- package/examples/component-box.md +112 -0
- package/examples/component-breadcrumb.md +222 -0
- package/examples/component-button-base.md +190 -0
- package/examples/component-button-group.md +117 -0
- package/examples/component-button.md +213 -0
- package/examples/component-calendar.md +280 -0
- package/examples/component-callout.md +131 -0
- package/examples/component-card-actions.md +101 -0
- package/examples/component-card-content.md +90 -0
- package/examples/component-card-header.md +122 -0
- package/examples/component-card-media.md +79 -0
- package/examples/component-card.md +233 -0
- package/examples/component-carousel.md +266 -0
- package/examples/component-cascader.md +135 -0
- package/examples/component-category-picker.md +271 -0
- package/examples/component-chart.md +237 -0
- package/examples/component-chat-interface.md +399 -0
- package/examples/component-checkbox.md +149 -0
- package/examples/component-click-away-listener.md +87 -0
- package/examples/component-code.md +213 -0
- package/examples/component-collapsible.md +219 -0
- package/examples/component-color-picker.md +110 -0
- package/examples/component-combobox.md +267 -0
- package/examples/component-command.md +299 -0
- package/examples/component-config-provider.md +190 -0
- package/examples/component-context-menu.md +179 -0
- package/examples/component-css-baseline.md +148 -0
- package/examples/component-date-picker.md +249 -0
- package/examples/component-descriptions.md +242 -0
- package/examples/component-dialog-actions.md +111 -0
- package/examples/component-dialog-content-text.md +76 -0
- package/examples/component-dialog-content.md +105 -0
- package/examples/component-dialog-title.md +104 -0
- package/examples/component-dialog.md +176 -0
- package/examples/component-divider.md +182 -0
- package/examples/component-doc-page.md +217 -0
- package/examples/component-drawer.md +257 -0
- package/examples/component-dropdown.md +220 -0
- package/examples/component-email-layout.md +253 -0
- package/examples/component-empty-state.md +269 -0
- package/examples/component-empty.md +172 -0
- package/examples/component-fade.md +87 -0
- package/examples/component-feature-grid.md +201 -0
- package/examples/component-field.md +266 -0
- package/examples/component-filled-input.md +114 -0
- package/examples/component-flex.md +117 -0
- package/examples/component-float-button.md +214 -0
- package/examples/component-form-control-label.md +134 -0
- package/examples/component-form-control.md +113 -0
- package/examples/component-form-controls.md +251 -0
- package/examples/component-form-group.md +86 -0
- package/examples/component-form-helper-text.md +95 -0
- package/examples/component-form-label.md +98 -0
- package/examples/component-form.md +291 -0
- package/examples/component-game-hud.md +362 -0
- package/examples/component-game-menu.md +327 -0
- package/examples/component-grid.md +140 -0
- package/examples/component-grow.md +79 -0
- package/examples/component-hero-block.md +252 -0
- package/examples/component-hover-card.md +211 -0
- package/examples/component-icon-button.md +142 -0
- package/examples/component-icon.md +102 -0
- package/examples/component-illustration.md +280 -0
- package/examples/component-image-list.md +107 -0
- package/examples/component-image.md +282 -0
- package/examples/component-input-adornment.md +101 -0
- package/examples/component-input-base.md +134 -0
- package/examples/component-input-number.md +141 -0
- package/examples/component-input-otp.md +271 -0
- package/examples/component-input.md +213 -0
- package/examples/component-item.md +243 -0
- package/examples/component-kbd.md +197 -0
- package/examples/component-krw-amount.md +219 -0
- package/examples/component-label.md +118 -0
- package/examples/component-layout.md +217 -0
- package/examples/component-link.md +223 -0
- package/examples/component-list-item-avatar.md +72 -0
- package/examples/component-list-item-button.md +139 -0
- package/examples/component-list-item-icon.md +82 -0
- package/examples/component-list-item-text.md +98 -0
- package/examples/component-list-item.md +116 -0
- package/examples/component-list-subheader.md +70 -0
- package/examples/component-list.md +198 -0
- package/examples/component-loading-button.md +125 -0
- package/examples/component-loading-sequence.md +254 -0
- package/examples/component-lottie-player.md +279 -0
- package/examples/component-masonry.md +191 -0
- package/examples/component-mentions.md +189 -0
- package/examples/component-menu-item.md +102 -0
- package/examples/component-menu-list.md +98 -0
- package/examples/component-menu.md +139 -0
- package/examples/component-menubar.md +259 -0
- package/examples/component-message.md +162 -0
- package/examples/component-mobile-stepper.md +155 -0
- package/examples/component-modal.md +220 -0
- package/examples/component-navigation-menu.md +295 -0
- package/examples/component-notification.md +166 -0
- package/examples/component-otp-countdown.md +245 -0
- package/examples/component-outlined-input.md +145 -0
- package/examples/component-page-transition.md +281 -0
- package/examples/component-pagination.md +226 -0
- package/examples/component-paper.md +199 -0
- package/examples/component-pass-auth.md +265 -0
- package/examples/component-payment-brand-button.md +253 -0
- package/examples/component-payment-method-selector.md +272 -0
- package/examples/component-payment-receipt.md +277 -0
- package/examples/component-popconfirm.md +144 -0
- package/examples/component-popover.md +239 -0
- package/examples/component-popper.md +129 -0
- package/examples/component-pricing-cards.md +247 -0
- package/examples/component-progress.md +195 -0
- package/examples/component-qr-code.md +201 -0
- package/examples/component-radio.md +167 -0
- package/examples/component-rate.md +202 -0
- package/examples/component-resizable.md +163 -0
- package/examples/component-result.md +270 -0
- package/examples/component-scroll-area.md +199 -0
- package/examples/component-scroll-reveal.md +320 -0
- package/examples/component-segmented.md +178 -0
- package/examples/component-select.md +258 -0
- package/examples/component-separator.md +177 -0
- package/examples/component-sheet.md +277 -0
- package/examples/component-sidebar.md +257 -0
- package/examples/component-skeleton.md +178 -0
- package/examples/component-slide.md +89 -0
- package/examples/component-slider.md +208 -0
- package/examples/component-snackbar-content.md +92 -0
- package/examples/component-snackbar.md +121 -0
- package/examples/component-sonner.md +165 -0
- package/examples/component-space.md +125 -0
- package/examples/component-spatial-locomotion.md +373 -0
- package/examples/component-spatial-panel.md +330 -0
- package/examples/component-speed-dial-action.md +78 -0
- package/examples/component-speed-dial.md +177 -0
- package/examples/component-spin.md +173 -0
- package/examples/component-spinner.md +204 -0
- package/examples/component-splitter.md +210 -0
- package/examples/component-stack.md +130 -0
- package/examples/component-statistic.md +282 -0
- package/examples/component-step-button.md +157 -0
- package/examples/component-step-connector.md +157 -0
- package/examples/component-step-content.md +121 -0
- package/examples/component-step-icon.md +115 -0
- package/examples/component-step-label.md +101 -0
- package/examples/component-step.md +84 -0
- package/examples/component-steps.md +264 -0
- package/examples/component-stock-chart.md +251 -0
- package/examples/component-swipeable-drawer.md +149 -0
- package/examples/component-switch.md +99 -0
- package/examples/component-tab-scroll-button.md +180 -0
- package/examples/component-tab.md +120 -0
- package/examples/component-table-body.md +82 -0
- package/examples/component-table-cell.md +118 -0
- package/examples/component-table-container.md +75 -0
- package/examples/component-table-footer.md +72 -0
- package/examples/component-table-head.md +78 -0
- package/examples/component-table-pagination.md +137 -0
- package/examples/component-table-row.md +113 -0
- package/examples/component-table-sort-label.md +109 -0
- package/examples/component-table.md +202 -0
- package/examples/component-tabs.md +184 -0
- package/examples/component-tag-badge.md +309 -0
- package/examples/component-tag.md +102 -0
- package/examples/component-testimonial-carousel.md +218 -0
- package/examples/component-textarea-autosize.md +114 -0
- package/examples/component-textarea.md +173 -0
- package/examples/component-time-picker.md +205 -0
- package/examples/component-timeline.md +170 -0
- package/examples/component-toast.md +224 -0
- package/examples/component-toggle-button.md +129 -0
- package/examples/component-toggle.md +220 -0
- package/examples/component-toolbar.md +104 -0
- package/examples/component-tooltip.md +178 -0
- package/examples/component-tour.md +176 -0
- package/examples/component-transaction-list-item.md +243 -0
- package/examples/component-transfer.md +156 -0
- package/examples/component-tree-select.md +202 -0
- package/examples/component-tree.md +297 -0
- package/examples/component-typography.md +215 -0
- package/examples/component-upload.md +295 -0
- package/examples/component-video-hero.md +409 -0
- package/examples/component-video-player.md +340 -0
- package/examples/component-voice-input.md +408 -0
- package/examples/component-watermark.md +217 -0
- package/examples/component-zoom.md +92 -0
- package/examples/doc-explanation-example.md +196 -0
- package/examples/doc-how-to-example.md +205 -0
- package/examples/doc-tutorial-example.md +162 -0
- package/examples/dogfood-korean-fintech-system.md +433 -0
- package/examples/email-transactional-example.md +259 -0
- package/examples/palette-saas-violet.md +235 -0
- package/examples/print-business-card-spec.md +205 -0
- package/examples/print-packaging-spec.md +285 -0
- package/examples/report-example.md +228 -0
- package/examples/slide-deck-example.md +237 -0
- package/examples/website-improvement-report.md +128 -0
- package/examples/website-improvement-workspace.json +126 -0
- package/install.sh +189 -0
- package/knowledge/COVERAGE.md +740 -0
- package/knowledge/PRINCIPLES.md +108 -0
- package/knowledge/a11y/contrast.md +70 -0
- package/knowledge/a11y/keyboard-and-focus.md +108 -0
- package/knowledge/colors/color-theory.md +90 -0
- package/knowledge/colors/mui-palette-structure.md +105 -0
- package/knowledge/colors/palettes-by-product-type.md +876 -0
- package/knowledge/components/INDEX.md +231 -0
- package/knowledge/components/index.json +1470 -0
- package/knowledge/components/shadcn-registry.md +159 -0
- package/knowledge/conversational/ai-chat-interfaces.md +323 -0
- package/knowledge/conversational/chatbot-design.md +312 -0
- package/knowledge/conversational/conversational-ui-fundamentals.md +299 -0
- package/knowledge/conversational/korean-voice-conventions.md +281 -0
- package/knowledge/conversational/voice-ui-patterns.md +297 -0
- package/knowledge/design-tokens/ant-design.md +124 -0
- package/knowledge/design-tokens/material-3.md +235 -0
- package/knowledge/design-tokens/polaris-and-carbon.md +231 -0
- package/knowledge/design-tokens/tailwind-v4.md +284 -0
- package/knowledge/game-ui/game-accessibility.md +317 -0
- package/knowledge/game-ui/game-ui-fundamentals.md +281 -0
- package/knowledge/game-ui/hud-design.md +324 -0
- package/knowledge/game-ui/korean-gaming-conventions.md +312 -0
- package/knowledge/game-ui/menu-systems.md +388 -0
- package/knowledge/i18n/korean-app-store-visual.md +223 -0
- package/knowledge/i18n/korean-document-style.md +301 -0
- package/knowledge/i18n/korean-payments.md +211 -0
- package/knowledge/i18n/korean-product-conventions.md +96 -0
- package/knowledge/i18n/korean-publishing.md +139 -0
- package/knowledge/i18n/korean-typography.md +123 -0
- package/knowledge/icons/curated-sets.md +225 -0
- package/knowledge/illustration/hero-illustrations.md +234 -0
- package/knowledge/illustration/illustration-systems.md +221 -0
- package/knowledge/illustration/mascot-design.md +208 -0
- package/knowledge/illustration/spot-illustrations.md +246 -0
- package/knowledge/illustration/svg-optimization.md +308 -0
- package/knowledge/layout/spacing-and-grid.md +119 -0
- package/knowledge/motion/app-loading-sequences.md +277 -0
- package/knowledge/motion/choreography-depth.md +297 -0
- package/knowledge/motion/marketing-motion.md +223 -0
- package/knowledge/motion/micro-interactions.md +266 -0
- package/knowledge/motion/motion-tools.md +281 -0
- package/knowledge/motion/principles.md +126 -0
- package/knowledge/patterns/auth-flow-design.md +316 -0
- package/knowledge/patterns/b2b-onboarding-flows.md +182 -0
- package/knowledge/patterns/brand-identity.md +238 -0
- package/knowledge/patterns/brand-references.md +97 -0
- package/knowledge/patterns/chart-color-encoding.md +269 -0
- package/knowledge/patterns/chart-types.md +344 -0
- package/knowledge/patterns/dashboard-composition.md +299 -0
- package/knowledge/patterns/design-system-qa.md +356 -0
- package/knowledge/patterns/document-typography.md +248 -0
- package/knowledge/patterns/email-design.md +338 -0
- package/knowledge/patterns/empty-states.md +263 -0
- package/knowledge/patterns/error-states.md +318 -0
- package/knowledge/patterns/form-design.md +237 -0
- package/knowledge/patterns/information-architecture.md +341 -0
- package/knowledge/patterns/landing-hero-design.md +283 -0
- package/knowledge/patterns/landing-page-patterns.md +681 -0
- package/knowledge/patterns/list-and-feed.md +371 -0
- package/knowledge/patterns/mobile-navigation.md +278 -0
- package/knowledge/patterns/money-and-amount.md +301 -0
- package/knowledge/patterns/onboarding.md +300 -0
- package/knowledge/patterns/pricing-page-design.md +261 -0
- package/knowledge/patterns/realtime-data.md +280 -0
- package/knowledge/patterns/report-design.md +330 -0
- package/knowledge/patterns/search-ux.md +373 -0
- package/knowledge/patterns/settings-page.md +325 -0
- package/knowledge/patterns/slide-deck-design.md +316 -0
- package/knowledge/patterns/styles-catalog.md +2599 -0
- package/knowledge/patterns/technical-writing.md +306 -0
- package/knowledge/patterns/ui-reasoning.md +1853 -0
- package/knowledge/patterns/ux-guidelines.md +1454 -0
- package/knowledge/platforms/react-native.md +395 -0
- package/knowledge/print/brochures-and-flyers.md +276 -0
- package/knowledge/print/korean-print-conventions.md +284 -0
- package/knowledge/print/packaging.md +321 -0
- package/knowledge/print/print-fundamentals.md +238 -0
- package/knowledge/print/signage-and-posters.md +235 -0
- package/knowledge/print/stationery.md +262 -0
- package/knowledge/spatial/ar-patterns.md +253 -0
- package/knowledge/spatial/comfort-and-accessibility.md +245 -0
- package/knowledge/spatial/spatial-design-fundamentals.md +346 -0
- package/knowledge/spatial/spatial-ui-elements.md +343 -0
- package/knowledge/spatial/vr-patterns.md +302 -0
- package/knowledge/typography/font-pairings.md +332 -0
- package/knowledge/typography/mui-type-scale.md +57 -0
- package/knowledge/typography/type-scale-fundamentals.md +105 -0
- package/knowledge/video/in-product-video.md +277 -0
- package/knowledge/video/korean-video-conventions.md +247 -0
- package/knowledge/video/marketing-video.md +258 -0
- package/knowledge/video/social-and-short-form.md +257 -0
- package/knowledge/video/video-fundamentals.md +296 -0
- package/package.json +106 -0
- package/skills/README.md +39 -0
- package/skills/color-palette/PLAYBOOK.md +175 -0
- package/skills/color-palette/SKILL.md +6 -0
- package/skills/color-palette/TEMPLATE.md +103 -0
- package/skills/component-spec-writer/PLAYBOOK.md +169 -0
- package/skills/component-spec-writer/SKILL.md +6 -0
- package/skills/component-spec-writer/TEMPLATE.md +115 -0
- package/skills/conversational-ui-designer/PLAYBOOK.md +231 -0
- package/skills/conversational-ui-designer/SKILL.md +6 -0
- package/skills/design-broadcast/PLAYBOOK.md +146 -0
- package/skills/design-broadcast/SKILL.md +6 -0
- package/skills/design-critique/PLAYBOOK.md +137 -0
- package/skills/design-critique/SKILL.md +6 -0
- package/skills/design-pr-review/PLAYBOOK.md +171 -0
- package/skills/design-pr-review/SKILL.md +6 -0
- package/skills/design-system-builder/PLAYBOOK.md +218 -0
- package/skills/design-system-builder/SKILL.md +6 -0
- package/skills/design-system-qa/PLAYBOOK.md +163 -0
- package/skills/design-system-qa/SKILL.md +6 -0
- package/skills/document-author/PLAYBOOK.md +167 -0
- package/skills/document-author/SKILL.md +6 -0
- package/skills/figma-token-sync/PLAYBOOK.md +149 -0
- package/skills/figma-token-sync/SKILL.md +6 -0
- package/skills/game-ui-designer/PLAYBOOK.md +209 -0
- package/skills/game-ui-designer/SKILL.md +6 -0
- package/skills/handoff-spec/PLAYBOOK.md +170 -0
- package/skills/handoff-spec/SKILL.md +6 -0
- package/skills/illustration-designer/PLAYBOOK.md +166 -0
- package/skills/illustration-designer/SKILL.md +6 -0
- package/skills/motion-designer/PLAYBOOK.md +223 -0
- package/skills/motion-designer/SKILL.md +6 -0
- package/skills/print-designer/PLAYBOOK.md +209 -0
- package/skills/print-designer/SKILL.md +6 -0
- package/skills/slide-deck-author/PLAYBOOK.md +198 -0
- package/skills/slide-deck-author/SKILL.md +6 -0
- package/skills/spatial-designer/PLAYBOOK.md +238 -0
- package/skills/spatial-designer/SKILL.md +6 -0
- package/skills/ux-audit/PLAYBOOK.md +142 -0
- package/skills/ux-audit/SKILL.md +6 -0
- package/skills/video-designer/PLAYBOOK.md +240 -0
- package/skills/video-designer/SKILL.md +6 -0
- package/skills/website-improvement/PLAYBOOK.md +118 -0
- package/skills/website-improvement/SKILL.md +6 -0
- package/skills/website-improvement/TEMPLATE.md +103 -0
- package/tools/audit/changelog-generate.py +176 -0
- package/tools/audit/check-coverage.py +483 -0
- package/tools/audit/doctor_assertions.py +256 -0
- package/tools/audit/example-qa.py +108 -0
- package/tools/audit/frontmatter-check.py +199 -0
- package/tools/audit/integration-check.py +95 -0
- package/tools/audit/korean-copy-check.py +161 -0
- package/tools/audit/link-check.py +146 -0
- package/tools/audit/local-ci.py +558 -0
- package/tools/audit/package-contents.py +723 -0
- package/tools/audit/package-smoke.py +22443 -0
- package/tools/audit/raw-hex-check.py +252 -0
- package/tools/audit/registry-smoke.py +8188 -0
- package/tools/audit/release-metadata.py +9832 -0
- package/tools/audit/run-all.py +351 -0
- package/tools/audit/smoke_assertions.py +12742 -0
- package/tools/audit/stability-review.py +332 -0
- package/tools/audit/stale-check.py +156 -0
- package/tools/migrations/add-version-frontmatter.py +132 -0
- package/tools/migrations/bump-last-updated.py +131 -0
- package/tools/migrations/promote-stability.py +172 -0
- package/tools/preview/README.md +58 -0
- package/tools/preview/render-tokens.py +454 -0
|
@@ -0,0 +1,223 @@
|
|
|
1
|
+
<!-- hand-written -->
|
|
2
|
+
---
|
|
3
|
+
title: Korean app store visual design
|
|
4
|
+
applies_to: [app-icon, app-store-screenshots, korean-app-store, ios, android]
|
|
5
|
+
version: 1.0.0
|
|
6
|
+
last_updated: 2026-05
|
|
7
|
+
stability: stable
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Korean app store visual design
|
|
11
|
+
|
|
12
|
+
The visual assets that get your app into the Korean App Store + Google Play Korea + ONE store: **app icon** and **screenshots**. This is design work distinct from in-app UI β it's marketing in a constrained, very-public surface.
|
|
13
|
+
|
|
14
|
+
For submission requirements (sizes, copy, age ratings): [`knowledge/i18n/korean-publishing.md`](korean-publishing.md). This file covers the **design** side.
|
|
15
|
+
|
|
16
|
+
## App icon
|
|
17
|
+
|
|
18
|
+
The single most-seen brand asset. On a phone home screen, your icon competes with 50 others.
|
|
19
|
+
|
|
20
|
+
### Conventions for Korean apps
|
|
21
|
+
|
|
22
|
+
- **Hangul letter inside icon** is acceptable and common. KakaoTalk uses "ν‘", Naver Pay uses "N", Toss uses "T". Single character or 2-char compounds.
|
|
23
|
+
- **English letter or wordmark** also common (KakaoBank uses dark blue with bird, Toss uses just "T" + dot).
|
|
24
|
+
- **Photo or detailed illustration** rare in Korean apps β most use flat geometric or single character.
|
|
25
|
+
- **Square corners** β iOS and Android both round corners automatically. Don't pre-round your icon.
|
|
26
|
+
|
|
27
|
+
### iOS icon spec
|
|
28
|
+
|
|
29
|
+
- Master at **1024Γ1024** PNG.
|
|
30
|
+
- No transparency (PNG-24 with solid bg).
|
|
31
|
+
- No padding β fill to the edges (iOS adds the rounded mask).
|
|
32
|
+
- Submit one icon β iOS handles all the @2x / @3x sizes.
|
|
33
|
+
- Color profile: sRGB.
|
|
34
|
+
|
|
35
|
+
### Android icon spec
|
|
36
|
+
|
|
37
|
+
- Master at **512Γ512** PNG (Play Console requires this).
|
|
38
|
+
- Adaptive icon: 108Γ108 dp foreground + 108Γ108 dp background, with the central 72Γ72 dp safe area.
|
|
39
|
+
- Provide foreground + background separately for adaptive icons.
|
|
40
|
+
|
|
41
|
+
### Test at thumbnail size
|
|
42
|
+
|
|
43
|
+
The first sign of a bad icon: it's unreadable at 60Γ60. Test at:
|
|
44
|
+
|
|
45
|
+
- 60px (iOS home screen at thumbnail density)
|
|
46
|
+
- 24px (notification, mini-icon contexts)
|
|
47
|
+
- 16px (favicon β if also used as web favicon)
|
|
48
|
+
|
|
49
|
+
If your icon is unreadable at 60: simplify. Drop fine details.
|
|
50
|
+
|
|
51
|
+
### Don't
|
|
52
|
+
|
|
53
|
+
- Don't put fine text (smaller than ~50px height in the master image) β illegible at thumbnail.
|
|
54
|
+
- Don't use photos.
|
|
55
|
+
- Don't use rounded corners pre-applied (iOS / Android apply their own mask).
|
|
56
|
+
- Don't use excessive gradients β read flat at thumbnail.
|
|
57
|
+
- Don't change icon between updates without warning users β recognition loss.
|
|
58
|
+
|
|
59
|
+
### Korean fintech / consumer icon trends
|
|
60
|
+
|
|
61
|
+
- Bold, single Hangul letter on solid bg (Toss "T", KakaoBank "tt").
|
|
62
|
+
- Brand color dominant.
|
|
63
|
+
- Often slight gradient OR flat solid.
|
|
64
|
+
- Rarely photo / illustration / 3D.
|
|
65
|
+
|
|
66
|
+
## Screenshots
|
|
67
|
+
|
|
68
|
+
Korean app stores reward screenshots that **sell the app, not show it**.
|
|
69
|
+
|
|
70
|
+
### Spec (App Store iOS)
|
|
71
|
+
|
|
72
|
+
| Device | Size | Required? |
|
|
73
|
+
| --- | --- | --- |
|
|
74
|
+
| iPhone 6.9" (Pro Max) | 1290 Γ 2796 | required |
|
|
75
|
+
| iPhone 6.5" / 6.7" | 1284 Γ 2778 / 1290 Γ 2796 | required |
|
|
76
|
+
| iPhone 6.1" | 1170 Γ 2532 | optional |
|
|
77
|
+
| iPad Pro 12.9" | 2048 Γ 2732 | required if iPad supported |
|
|
78
|
+
| iPad Pro 11" | 1668 Γ 2388 | required if iPad supported |
|
|
79
|
+
|
|
80
|
+
Submit one set; iOS scales for older devices.
|
|
81
|
+
|
|
82
|
+
### Spec (Google Play)
|
|
83
|
+
|
|
84
|
+
| Field | Spec |
|
|
85
|
+
| --- | --- |
|
|
86
|
+
| Phone screenshots | 16:9 to 9:16 ratio. 1080 Γ 1920 minimum. |
|
|
87
|
+
| 7-inch tablet | 1024 Γ 600 minimum |
|
|
88
|
+
| 10-inch tablet | 1280 Γ 800 minimum |
|
|
89
|
+
| Count | 2β8 (3+ recommended) |
|
|
90
|
+
|
|
91
|
+
### Korean screenshot conventions
|
|
92
|
+
|
|
93
|
+
Korean storefront expects much higher density than Western apps. Typical structure per screenshot:
|
|
94
|
+
|
|
95
|
+
```
|
|
96
|
+
ββββββββββββββββββββββββββββββββββββββββ
|
|
97
|
+
β β
|
|
98
|
+
β LARGE BENEFIT COPY (1-2 lines) β β top 30%, bold, Korean
|
|
99
|
+
β Sub-line β
|
|
100
|
+
β β
|
|
101
|
+
β βββββββββββββββββββ β
|
|
102
|
+
β β β β
|
|
103
|
+
β β [Phone frame β β
|
|
104
|
+
β β with screen] β β β center, mockup of in-app screen
|
|
105
|
+
β β β β
|
|
106
|
+
β β β β
|
|
107
|
+
β βββββββββββββββββββ β
|
|
108
|
+
β β
|
|
109
|
+
β Background color β β brand color or gradient
|
|
110
|
+
ββββββββββββββββββββββββββββββββββββββββ
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
| Slot | Notes |
|
|
114
|
+
| --- | --- |
|
|
115
|
+
| Benefit copy | "30μ΄λ§μ μλ£" / "μν λ°λ‘ μ κ°μ" β sells the value, not the feature |
|
|
116
|
+
| Phone mockup | App screen inside a phone frame for "this is how it looks" credibility |
|
|
117
|
+
| Background | Brand color or simple gradient β never plain white (looks unfinished) |
|
|
118
|
+
|
|
119
|
+
Western "minimal screenshot" (just the app screen on white) is **uncommon and underperforms** in the Korean storefront. Add the marketing layer.
|
|
120
|
+
|
|
121
|
+
### First 3 screenshots are critical
|
|
122
|
+
|
|
123
|
+
The Korean storefront shows 3 screenshots without scrolling. Front-load:
|
|
124
|
+
|
|
125
|
+
1. **Hero benefit** β the #1 reason to install ("κ°κ³λΆ μλ μ
λ ₯")
|
|
126
|
+
2. **Differentiation** β what's different from competitors ("μ°λ μν 30κ³³, 1μ΄ λκΈ°ν")
|
|
127
|
+
3. **Trust signal** β proof point ("100λ§ μ¬μ©μ, νμ 4.8")
|
|
128
|
+
|
|
129
|
+
Subsequent screenshots dive into specific features.
|
|
130
|
+
|
|
131
|
+
### Screenshot copy
|
|
132
|
+
|
|
133
|
+
| Korean | English equivalent | Use |
|
|
134
|
+
| --- | --- | --- |
|
|
135
|
+
| 30μ΄λ§μ μλ£ | "Done in 30 seconds" | Speed |
|
|
136
|
+
| ν λ²μ 보λ | "All in one view" | Comprehensiveness |
|
|
137
|
+
| μλμΌλ‘ λΆλ₯ | "Auto-categorized" | Effort-saving |
|
|
138
|
+
| λ§€μΌ μλ €λλ €μ | "Daily updates" | Habit |
|
|
139
|
+
| κ³μ’ μ°λ Nκ° | "N banks connected" | Coverage |
|
|
140
|
+
| β
β
β
β
β
νμ 4.8 | "β
β
β
β
β
4.8 rating" | Social proof |
|
|
141
|
+
| λΉλ°λ²νΈ μμ΄ | "No password" | Convenience |
|
|
142
|
+
| λͺ¨λ μΉ΄λ ν κ³³μ | "All cards in one place" | Aggregation |
|
|
143
|
+
|
|
144
|
+
Voice: short, declarative, action-led. Avoid hedging ("μ½κ²", "νΈλ¦¬νκ²" alone β be specific).
|
|
145
|
+
|
|
146
|
+
### Localization
|
|
147
|
+
|
|
148
|
+
For multi-locale apps:
|
|
149
|
+
- Submit Korean screenshots for KR storefront.
|
|
150
|
+
- Submit English screenshots for US storefront.
|
|
151
|
+
- Don't send English to KR β instant rejection on App Store.
|
|
152
|
+
|
|
153
|
+
This is non-trivial work. Plan in your release timeline.
|
|
154
|
+
|
|
155
|
+
## Promo / featured assets
|
|
156
|
+
|
|
157
|
+
For App Store featuring (the "Today" tab):
|
|
158
|
+
- Hero image: 1920 Γ 1080 or 1242 Γ 2688
|
|
159
|
+
- Promo text: 170 chars max
|
|
160
|
+
- Different from regular store listing β submit if you're chasing featured slots.
|
|
161
|
+
|
|
162
|
+
For Google Play featured: similar but spec varies by promo type.
|
|
163
|
+
|
|
164
|
+
## Trends in Korean app store design
|
|
165
|
+
|
|
166
|
+
Korean App Store + Play KR converge on a few visual languages:
|
|
167
|
+
|
|
168
|
+
### Toss-style
|
|
169
|
+
|
|
170
|
+
Minimalist, single-color background, big bold Korean text, clean phone mockup. Feels modern, finance-coded.
|
|
171
|
+
|
|
172
|
+
### Kakao-style
|
|
173
|
+
|
|
174
|
+
Yellow + black palette, friendly illustrations alongside mockups. Warmer, consumer-coded.
|
|
175
|
+
|
|
176
|
+
### Naver-style
|
|
177
|
+
|
|
178
|
+
Green palette, more dense (more text per screenshot), portal-coded.
|
|
179
|
+
|
|
180
|
+
### Government / 곡곡기κ΄
|
|
181
|
+
|
|
182
|
+
Blue palette, formal sans-serif, screenshot-heavy with conservative copy. Government apps are visually distinct.
|
|
183
|
+
|
|
184
|
+
Pick one direction; stay consistent across all 3+ screenshots.
|
|
185
|
+
|
|
186
|
+
## Don't
|
|
187
|
+
|
|
188
|
+
- Don't ship English screenshots to Korean storefront.
|
|
189
|
+
- Don't ship plain "screenshot of in-app UI on white" β looks unfinished.
|
|
190
|
+
- Don't use stock illustrations of people pointing at phones.
|
|
191
|
+
- Don't have 4+ benefit lines on one screenshot β cluttered.
|
|
192
|
+
- Don't use brand colors that fail dark/light contrast tests in store search results.
|
|
193
|
+
- Don't promise features that aren't in the app (App Store rejects, users 1-star).
|
|
194
|
+
- Don't update only screenshots without updating the app description / version notes.
|
|
195
|
+
|
|
196
|
+
## Tools
|
|
197
|
+
|
|
198
|
+
| Tool | Use |
|
|
199
|
+
| --- | --- |
|
|
200
|
+
| **Figma** | Design screenshots; phone-frame templates |
|
|
201
|
+
| **Screenshot.rocks** | Quick mockup generator |
|
|
202
|
+
| **AppLaunchpad** | Korean storefront-aware templates |
|
|
203
|
+
| **fastlane snapshot** | Auto-generate iOS screenshots from UI tests |
|
|
204
|
+
| **Screenshot Studio** | Sketch/Figma-friendly mockup |
|
|
205
|
+
|
|
206
|
+
For consistency: design screenshots in Figma with brand tokens (per design-ai's color/type tokens).
|
|
207
|
+
|
|
208
|
+
## Iteration / A/B testing
|
|
209
|
+
|
|
210
|
+
Apple App Store + Google Play both support **screenshot A/B tests**. Test:
|
|
211
|
+
- First-screenshot benefit copy.
|
|
212
|
+
- Whether to include phone frame.
|
|
213
|
+
- Brand color saturation.
|
|
214
|
+
|
|
215
|
+
20β30% changes in install conversion are not unusual. Worth testing.
|
|
216
|
+
|
|
217
|
+
## Cross-reference
|
|
218
|
+
|
|
219
|
+
- [`knowledge/i18n/korean-publishing.md`](korean-publishing.md) β submission requirements + age ratings
|
|
220
|
+
- [`knowledge/i18n/korean-product-conventions.md`](korean-product-conventions.md) β broader KR app conventions
|
|
221
|
+
- [`knowledge/patterns/brand-identity.md`](../patterns/brand-identity.md) β logo + brand applied to icon design
|
|
222
|
+
- [`knowledge/patterns/slide-deck-design.md`](../patterns/slide-deck-design.md) β similar headline-led visual strategy
|
|
223
|
+
- App Store / Play Store official guidelines (linked from korean-publishing.md)
|
|
@@ -0,0 +1,301 @@
|
|
|
1
|
+
<!-- hand-written -->
|
|
2
|
+
---
|
|
3
|
+
title: Korean document style β voice, hierarchy, conventions
|
|
4
|
+
applies_to: [korean-docs, korean-reports, korean-presentations, korean-marketing-prose]
|
|
5
|
+
version: 1.0.0
|
|
6
|
+
last_updated: 2026-05
|
|
7
|
+
stability: stable
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Korean document style
|
|
11
|
+
|
|
12
|
+
How Korean documents differ from Latin / English ones in voice, hierarchy, formatting, and convention. Critical for any document going to a Korean audience.
|
|
13
|
+
|
|
14
|
+
## Honorific level (μ‘΄λλ§ vs λ°λ§)
|
|
15
|
+
|
|
16
|
+
The first decision: which level of speech. Different from "polite vs casual" in English β Korean has structural levels.
|
|
17
|
+
|
|
18
|
+
| Level | When to use | Example |
|
|
19
|
+
| --- | --- | --- |
|
|
20
|
+
| **ν©μΌμ²΄** (~ν©λλ€ / ~μ
λλ€) | Formal β official documents, contracts, B2B reports, government, banking, business proposals | "λ³Έ λ³΄κ³ μλ ... λΆμν©λλ€." |
|
|
21
|
+
| **ν΄μ체** (~ν΄μ / ~μμ) | Polite-casual β consumer apps, friendly product docs, customer-facing | "μ΄ κΈ°λ₯μ μλμΌλ‘ λκΈ°νλΌμ." |
|
|
22
|
+
| **ν΄μ²΄** (λ°λ§, ~ν΄ / ~μΌ) | **Don't use** in product docs / customer-facing | (avoid) |
|
|
23
|
+
| **νκ²μ²΄** / **νμ€μ²΄** | Archaic / regional. Avoid. | β |
|
|
24
|
+
|
|
25
|
+
For most product documentation: **ν©μΌμ²΄** is the default.
|
|
26
|
+
For consumer / friendly docs: **ν΄μ체** is acceptable.
|
|
27
|
+
|
|
28
|
+
### Mixing
|
|
29
|
+
|
|
30
|
+
Don't switch levels within a document. Pick one and commit.
|
|
31
|
+
|
|
32
|
+
Common error: mixing **νμμμ€μ²΄** ("μ£Όμμμ€" = please) with **ν΄μ체** in the same paragraph. Pick one register.
|
|
33
|
+
|
|
34
|
+
## Punctuation
|
|
35
|
+
|
|
36
|
+
Korean documents use **English punctuation conventions** when mixed with code or English terms:
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
β "APIλ λ€μκ³Ό κ°μ΄ μμ±λ©λλ€: ..."
|
|
40
|
+
β "μ΄ ν¨μλ stringμ λ°νν©λλ€."
|
|
41
|
+
β "APIλ λ€μκ³Ό κ°μ΄ μμ±λ©λλ€γ ..." (Japanese punctuation, wrong)
|
|
42
|
+
β "μ΄ ν¨μλ stringμ λ°νν©λλ€.." (double period)
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
For purely Korean prose (literary, traditional): the Korean punctuation `.` (full stop) and `,` (comma) work fine β they're Latin marks.
|
|
46
|
+
|
|
47
|
+
The Japanese-style `γ` and `γ` are NOT Korean β don't use.
|
|
48
|
+
|
|
49
|
+
## Hangul + English interleaving
|
|
50
|
+
|
|
51
|
+
Korean technical docs mix Korean and English heavily. Standard rules:
|
|
52
|
+
|
|
53
|
+
| Type | Convention |
|
|
54
|
+
| --- | --- |
|
|
55
|
+
| Code identifiers | English, monospace, no translation: `getUserById()` |
|
|
56
|
+
| Function descriptions | Korean prose around English code |
|
|
57
|
+
| Acronyms | English: API, URL, JSON, OAuth |
|
|
58
|
+
| Brand names | Original: Figma (not νΌκ·Έλ§), GitHub (not κΉνλΈ) |
|
|
59
|
+
| Technical terms with established Korean | Korean: μ¬μ©μ (user), νλ©΄ (screen), νμ΄μ§ (page) |
|
|
60
|
+
| Newer terms with no established Korean | English in parens: μ»΄ν¬μ§μ
(composition) |
|
|
61
|
+
|
|
62
|
+
Example sentence:
|
|
63
|
+
```
|
|
64
|
+
"μ΄ APIλ μ¬μ©μ IDλ₯Ό λ°μ User κ°μ²΄λ₯Ό λ°νν©λλ€."
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Korean for "this API takes user ID and returns User object." Korean prose, English code, English-Korean technical terms.
|
|
68
|
+
|
|
69
|
+
## Spacing
|
|
70
|
+
|
|
71
|
+
Korean text has **specific spacing rules** (λμ΄μ°κΈ°). They differ from English. Common cases for product docs:
|
|
72
|
+
|
|
73
|
+
| Rule | Example |
|
|
74
|
+
| --- | --- |
|
|
75
|
+
| Particles attach to noun | `μ¬μ©μκ°` (not `μ¬μ©μ κ°`) |
|
|
76
|
+
| Compound noun: typically together | `λ‘κ·ΈμΈ νλ©΄` OK; `λ‘κ·ΈμΈνλ©΄` also OK in technical docs |
|
|
77
|
+
| Number + unit: separate | `5 ms`, `12 px`, `30 μ΄` |
|
|
78
|
+
| Foreign word (loanword) + Korean: separate | `API νΈμΆ`, `JSON νμ±` |
|
|
79
|
+
|
|
80
|
+
Many subtle rules. For docs: use a Korean spell-checker / `νλλμμλ` / similar tool.
|
|
81
|
+
|
|
82
|
+
## Hierarchy structures
|
|
83
|
+
|
|
84
|
+
Korean documents use **numbered hierarchical sections** more than English ones:
|
|
85
|
+
|
|
86
|
+
```
|
|
87
|
+
1. κ°μ
|
|
88
|
+
1.1. λ°°κ²½
|
|
89
|
+
1.2. λͺ©μ
|
|
90
|
+
2. λΆμ
|
|
91
|
+
2.1. νν©
|
|
92
|
+
2.1.1. μ¬μ©μ νλ
|
|
93
|
+
2.1.2. λ§€μΆ μΆμ΄
|
|
94
|
+
2.2. λ¬Έμ μ
|
|
95
|
+
3. μ μ
|
|
96
|
+
3.1. ...
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
Western docs often skip numbering past the title. Korean business docs (λ³΄κ³ μ, μ μμ) standard practice is full numeric hierarchy.
|
|
100
|
+
|
|
101
|
+
For technical product docs: less strict β heading levels are enough.
|
|
102
|
+
|
|
103
|
+
## Heading-numbering equivalents
|
|
104
|
+
|
|
105
|
+
Korean documents may use these markers for sub-points:
|
|
106
|
+
|
|
107
|
+
| Marker | Use |
|
|
108
|
+
| --- | --- |
|
|
109
|
+
| κ°, λ, λ€, ... | Sub-bullet ordering (alphabetical equivalent) |
|
|
110
|
+
| γ±, γ΄, γ·, ... | Older alphabetical |
|
|
111
|
+
| 1, 2, 3 | Standard numeric |
|
|
112
|
+
| β , β‘, β’ | Tight numeric (often used in compact specs) |
|
|
113
|
+
| γ , γ‘, γ’ | Alternative β common in legal docs |
|
|
114
|
+
|
|
115
|
+
Most product / technical docs: `1, 2, 3` and `κ°, λ, λ€` are sufficient.
|
|
116
|
+
|
|
117
|
+
## Document framing
|
|
118
|
+
|
|
119
|
+
### λ³΄κ³ μ (formal report)
|
|
120
|
+
|
|
121
|
+
Typical structure:
|
|
122
|
+
|
|
123
|
+
```
|
|
124
|
+
νμ§ (cover page)
|
|
125
|
+
- Title
|
|
126
|
+
- Subtitle / period
|
|
127
|
+
- Author / dept
|
|
128
|
+
- Date
|
|
129
|
+
|
|
130
|
+
λͺ©μ°¨ (table of contents)
|
|
131
|
+
|
|
132
|
+
I. κ°μ (Overview)
|
|
133
|
+
II. λ³Έλ‘ (Body)
|
|
134
|
+
III. κ²°λ‘ (Conclusion)
|
|
135
|
+
IV. λΆλ‘ (Appendix)
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
Each section uses Roman numeral I/II/III, then sub-numbers.
|
|
139
|
+
|
|
140
|
+
### μ μμ (proposal)
|
|
141
|
+
|
|
142
|
+
Sales / business proposal:
|
|
143
|
+
|
|
144
|
+
```
|
|
145
|
+
1. νμ¬ μκ°
|
|
146
|
+
2. μ μ μμ½
|
|
147
|
+
3. μ 곡 λ΄μ©
|
|
148
|
+
3.1. λ²μ
|
|
149
|
+
3.2. μΌμ
|
|
150
|
+
3.3. λΉμ©
|
|
151
|
+
4. κΈ°λ ν¨κ³Ό
|
|
152
|
+
5. λΆλ‘
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### Tutorial / νν 리μΌ
|
|
156
|
+
|
|
157
|
+
Friendlier, less hierarchical:
|
|
158
|
+
|
|
159
|
+
```
|
|
160
|
+
μμνκΈ°
|
|
161
|
+
첫 λ²μ§Έ λ¨κ³
|
|
162
|
+
λ λ²μ§Έ λ¨κ³
|
|
163
|
+
μλ£!
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
Headings can be questions ("μ΄ λ¨κ³λ 무μμ νλμ?") or statements ("νλ‘μ νΈλ₯Ό λ§λ€μ΄ λ΄
μλ€").
|
|
167
|
+
|
|
168
|
+
## Numbers and statistics
|
|
169
|
+
|
|
170
|
+
Korean documents typically:
|
|
171
|
+
- Numerals in Arabic digits, separators with `,` (Western convention).
|
|
172
|
+
- Korean number names (λ§, μ΅) for very large display numbers.
|
|
173
|
+
- "μ½" (approximately) before estimated numbers.
|
|
174
|
+
- "μ΄μ" / "μ΄ν" for ranges ("100λͺ
μ΄μ", "10% μ΄ν").
|
|
175
|
+
- λ°±λΆμ¨ / νΌμΌνΈ: `80%` (Latin) or `80νΌμΌνΈ` (Korean) β both acceptable.
|
|
176
|
+
|
|
177
|
+
## Dates and times
|
|
178
|
+
|
|
179
|
+
| Format | Example | Use |
|
|
180
|
+
| --- | --- | --- |
|
|
181
|
+
| YYYY.MM.DD | `2026.05.08` | Compact β most product docs |
|
|
182
|
+
| YYYYλ
Mμ DμΌ | `2026λ
5μ 8μΌ` | Formal |
|
|
183
|
+
| YYYY-MM-DD | `2026-05-08` | Technical / ISO |
|
|
184
|
+
| Mμ DμΌ (μμΌ) | `5μ 8μΌ (λͺ©)` | Casual |
|
|
185
|
+
|
|
186
|
+
Time:
|
|
187
|
+
- 24-hour: `14:30` β most Korean docs.
|
|
188
|
+
- 12-hour: `μ€ν 2:30` β older / formal.
|
|
189
|
+
|
|
190
|
+
Mix consistently within a doc.
|
|
191
|
+
|
|
192
|
+
## Currency
|
|
193
|
+
|
|
194
|
+
| Format | Use |
|
|
195
|
+
| --- | --- |
|
|
196
|
+
| `1,200,000μ` | Suffix style (consumer / casual) |
|
|
197
|
+
| `β©1,200,000` | Prefix style (fintech / Western-coded) |
|
|
198
|
+
| `120λ§μ` | Korean compact (λ§/μ΅) |
|
|
199
|
+
| `1.2Mμ` | Mixed (rare in formal docs) |
|
|
200
|
+
|
|
201
|
+
Cite [`knowledge/patterns/money-and-amount.md`](../patterns/money-and-amount.md). Pick one and stay consistent.
|
|
202
|
+
|
|
203
|
+
## Korean technical writing tone
|
|
204
|
+
|
|
205
|
+
Per [`knowledge/patterns/technical-writing.md`](../patterns/technical-writing.md), but for Korean:
|
|
206
|
+
|
|
207
|
+
### Polite imperative
|
|
208
|
+
|
|
209
|
+
| English imperative | Korean (~ν©λλ€ / ν©λλ€) |
|
|
210
|
+
| --- | --- |
|
|
211
|
+
| "Save the file." | "νμΌμ μ μ₯ν©λλ€." (declarative) / "νμΌμ μ μ₯νμΈμ." (imperative) |
|
|
212
|
+
| "Run the command." | "λͺ
λ Ήμ΄λ₯Ό μ€νν©λλ€." / "λͺ
λ Ήμ΄λ₯Ό μ€ννμΈμ." |
|
|
213
|
+
| "Click the button." | "λ²νΌμ ν΄λ¦νμΈμ." |
|
|
214
|
+
|
|
215
|
+
For instructional docs: imperative `~νμΈμ` is standard.
|
|
216
|
+
For passive description: `~ν©λλ€` (the function does X).
|
|
217
|
+
|
|
218
|
+
### Voice attributes
|
|
219
|
+
|
|
220
|
+
For most product docs:
|
|
221
|
+
- **μ°¨λΆν¨ (calm)** β no hype.
|
|
222
|
+
- **λͺ
νν¨ (clarity)** β short sentences, one idea each.
|
|
223
|
+
- **μΉμ ν¨ (kind)** β guide the reader, don't lecture.
|
|
224
|
+
|
|
225
|
+
For Korean fintech / banking docs specifically:
|
|
226
|
+
- More formal (~ν©λλ€).
|
|
227
|
+
- Conservative palette / typography.
|
|
228
|
+
- Numbered structure.
|
|
229
|
+
- Disclaimers + legal language at the end.
|
|
230
|
+
|
|
231
|
+
## Common Korean document errors
|
|
232
|
+
|
|
233
|
+
### Particle errors
|
|
234
|
+
- μ/λ vs μ΄/κ°: subject vs topic. Subtle but matters.
|
|
235
|
+
- μ/λ₯Ό: object marker.
|
|
236
|
+
- μ (overuse): "μ¬μ©μμ λ°μ΄ν°μ μ²λ¦¬" feels stiff. Prefer compound: "μ¬μ©μ λ°μ΄ν° μ²λ¦¬".
|
|
237
|
+
|
|
238
|
+
### Repetition
|
|
239
|
+
Korean is **less tolerant of word repetition** than English. Vary verbs, find synonyms.
|
|
240
|
+
|
|
241
|
+
```
|
|
242
|
+
β "μ΄ ν¨μλ λ°μ΄ν°λ₯Ό λ°μμ, λ°μ΄ν°λ₯Ό μ²λ¦¬νκ³ , λ°μ΄ν°λ₯Ό λ°νν©λλ€."
|
|
243
|
+
β "μ΄ ν¨μλ λ°μ΄ν°λ₯Ό λ°μ μ²λ¦¬ν ν κ²°κ³Όλ₯Ό λ°νν©λλ€."
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
### Direct translation from English
|
|
247
|
+
Many phrases that are natural in English are awkward in Korean:
|
|
248
|
+
|
|
249
|
+
| Don't translate directly | Use instead |
|
|
250
|
+
| --- | --- |
|
|
251
|
+
| "Make sure to ..." | "λ°λμ ~ν©λλ€." |
|
|
252
|
+
| "Click here to ..." | "μ΄κ³³μ ν΄λ¦νλ©΄ ~λ©λλ€." |
|
|
253
|
+
| "Note that ..." | "μ°Έκ³ : ~", "μ£Όμ: ~" |
|
|
254
|
+
| "By default, ..." | "κΈ°λ³Έκ°μ ~μ
λλ€." |
|
|
255
|
+
| "X will ..." (future tense for behavior) | "Xκ° ~ν©λλ€" (present tense, declarative) |
|
|
256
|
+
|
|
257
|
+
Read aloud β if it sounds like a translation, rewrite.
|
|
258
|
+
|
|
259
|
+
## Korean document templates
|
|
260
|
+
|
|
261
|
+
### Email β formal business
|
|
262
|
+
|
|
263
|
+
```
|
|
264
|
+
[λ°λ λΆ μ΄λ¦] λ,
|
|
265
|
+
|
|
266
|
+
μλ
νμΈμ. [νμ¬λͺ
] [λΆμλͺ
] [λ³ΈμΈ μ΄λ¦]μ
λλ€.
|
|
267
|
+
|
|
268
|
+
[λ³Έλ¬Έ β νμν λ¬Έμ₯ μ μ§]
|
|
269
|
+
|
|
270
|
+
κ²ν ν νμ λΆνλ립λλ€.
|
|
271
|
+
|
|
272
|
+
κ°μ¬ν©λλ€.
|
|
273
|
+
|
|
274
|
+
[λ³ΈμΈ μ΄λ¦]
|
|
275
|
+
[μ§μ±
/ λΆμ]
|
|
276
|
+
[μ°λ½μ²]
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
### Email β friendly product
|
|
280
|
+
|
|
281
|
+
```
|
|
282
|
+
μλ
νμΈμ, {{first_name}} λ.
|
|
283
|
+
|
|
284
|
+
[λ³Έλ¬Έ]
|
|
285
|
+
|
|
286
|
+
κ°μ¬ν©λλ€.
|
|
287
|
+
{{Company name}} λλ¦Ό
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
### Internal Slack / messenger
|
|
291
|
+
|
|
292
|
+
Casual ~ν΄μ acceptable. Bullet points common.
|
|
293
|
+
|
|
294
|
+
## Cross-reference
|
|
295
|
+
|
|
296
|
+
- [`knowledge/i18n/korean-typography.md`](korean-typography.md) β type rules
|
|
297
|
+
- [`knowledge/i18n/korean-product-conventions.md`](korean-product-conventions.md) β broader Korean UX conventions
|
|
298
|
+
- [`knowledge/patterns/document-typography.md`](../patterns/document-typography.md) β visual styling
|
|
299
|
+
- [`knowledge/patterns/technical-writing.md`](../patterns/technical-writing.md) β voice rules
|
|
300
|
+
- [`knowledge/patterns/report-design.md`](../patterns/report-design.md) β report structure
|
|
301
|
+
- [κ΅λ¦½κ΅μ΄μ](https://www.korean.go.kr/) β official Korean language reference
|