Back to Details

moai-workflow-project

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

MoAI Workflow Project - Integrated Project Management System

MoAI 工作流项目 - 集成项目管理系统

Purpose: Comprehensive project management system that integrates documentation generation, multilingual support, and template optimization into unified architecture with intelligent automation and Claude Code integration.
Scope: Consolidates documentation management, language initialization, and template optimization into single cohesive system supporting complete project lifecycle from initialization to maintenance.
Target: Claude Code agents for project setup, documentation generation, multilingual support, and performance optimization.
用途：集文档生成、多语言支持和模板优化于一体的综合性项目管理系统，采用智能自动化与Claude Code集成架构。
适用范围：将文档管理、语言初始化和模板优化整合为统一系统，支持从初始化到维护的完整项目生命周期。
目标用户：用于项目搭建、文档生成、多语言支持及性能优化的Claude Code Agent。

Quick Reference

快速参考

Core Capabilities:
  • Documentation Management: Template-based documentation generation with multilingual support
  • Language Initialization: Language detection, configuration, and localization management
  • Template Optimization: Advanced template analysis and performance optimization
  • Unified Interface: Single entry point integrating all capabilities
Key Features:
  • Automatic project type detection and template selection
  • Multilingual documentation generation supporting English, Korean, Japanese, and Chinese
  • Intelligent template optimization with performance benchmarking
  • SPEC-driven documentation updates
  • Multi-format export including Markdown, HTML, and PDF
Supported Project Types:
  • Web applications
  • Mobile applications
  • Command-line interface tools
  • Libraries and packages
  • Machine learning projects
核心功能：
  • 文档管理：基于模板的文档生成，支持多语言
  • 语言初始化：语言检测、配置与本地化管理
  • 模板优化：高级模板分析与性能优化
  • 统一界面：集成所有功能的单一入口
关键特性：
  • 自动项目类型检测与模板选择
  • 支持英语、韩语、日语和中文的多语言文档生成
  • 带性能基准测试的智能模板优化
  • 基于SPEC的文档更新
  • 支持Markdown、HTML和PDF等多格式导出
支持的项目类型：
  • Web应用
  • 移动应用
  • 命令行界面工具
  • 库与包
  • 机器学习项目

Implementation Guide

实施指南

Module Architecture

模块架构

Documentation Management Capabilities:
  • Template-based documentation generation
  • Project type detection for web, mobile, CLI, library, and ML projects
  • Multilingual support with localized content
  • SPEC data integration for automatic updates
  • Multi-format export capabilities
Language Initialization Capabilities:
  • Automatic language detection from project content
  • Comprehensive language configuration management
  • Agent prompt localization with cost optimization
  • Domain-specific language support
  • Locale management and cultural adaptation
Template Optimization Capabilities:
  • Advanced template analysis with complexity metrics
  • Performance optimization with size reduction
  • Intelligent backup and recovery system
  • Benchmarking and performance tracking
  • Automated optimization recommendations
文档管理功能：
  • 基于模板的文档生成
  • 针对Web、移动、CLI、库和ML项目的类型检测
  • 带本地化内容的多语言支持
  • 集成SPEC数据实现自动更新
  • 多格式导出能力
语言初始化功能：
  • 从项目内容中自动检测语言
  • 全面的语言配置管理
  • 带成本优化的Agent提示词本地化
  • 特定领域语言支持
  • 区域设置管理与文化适配
模板优化功能：
  • 带复杂度指标的高级模板分析
  • 针对文件体积缩减的性能优化
  • 智能备份与恢复系统
  • 基准测试与性能跟踪
  • 自动化优化建议

Core Workflows

核心工作流

Complete Project Initialization Workflow:
Step 1: Initialize the project management system by specifying the project directory path
Step 2: Execute complete setup with the following configuration parameters:
  • Language setting: Specify the primary language code such as "en" for English or "ko" for Korean
  • User name: Provide the developer or team name for personalization
  • Domains: List the project domains such as backend, frontend, and mobile
  • Project type: Specify the project type such as web_application
  • Optimization enabled: Set to true to enable template optimization during initialization
Step 3: Review initialization results which include:
  • Language configuration with token cost analysis
  • Documentation structure creation status
  • Template analysis and optimization report
  • Multilingual documentation setup confirmation
Documentation Generation from SPEC Workflow:
Step 1: Prepare SPEC data with the following structure:
  • Identifier: Unique SPEC ID such as SPEC-001
  • Title: Feature or component title
  • Description: Brief description of the implementation
  • Requirements: List of specific requirements
  • Status: Current status such as Planned, In Progress, or Complete
  • Priority: Priority level such as High, Medium, or Low
  • API Endpoints: List of endpoint definitions including path, method, and description
Step 2: Generate comprehensive documentation from the SPEC data
Step 3: Review generated documentation which includes:
  • Feature documentation with requirements
  • API documentation with endpoint details
  • Updated project documentation files
  • Multilingual versions if configured
Template Performance Optimization Workflow:
Step 1: Analyze current templates to gather metrics
Step 2: Configure optimization options:
  • Backup first: Set to true to create backup before optimization
  • Apply size optimizations: Enable to reduce file sizes
  • Apply performance optimizations: Enable to improve loading times
  • Apply complexity optimizations: Enable to simplify template structures
  • Preserve functionality: Ensure all features remain intact
Step 3: Execute optimization and review results:
  • Size reduction percentage achieved
  • Performance improvement metrics
  • Backup creation confirmation
  • Detailed optimization report
完整项目初始化工作流：
步骤1：通过指定项目目录路径初始化项目管理系统
步骤2：使用以下配置参数执行完整设置：
  • 语言设置：指定主语言代码，如英语的"en"或韩语的"ko"
  • 用户名：提供开发者或团队名称用于个性化设置
  • 领域：列出项目领域，如后端、前端和移动
  • 项目类型：指定项目类型，如web_application
  • 启用优化：设置为true以在初始化期间启用模板优化
步骤3：查看初始化结果，包括：
  • 带Token成本分析的语言配置
  • 文档结构创建状态
  • 模板分析与优化报告
  • 多语言文档设置确认
基于SPEC的文档生成工作流：
步骤1：准备以下结构的SPEC数据：
  • 标识符：唯一的SPEC ID，如SPEC-001
  • 标题：功能或组件标题
  • 描述：实现方案的简要说明
  • 需求：具体需求列表
  • 状态：当前状态，如计划中、进行中或已完成
  • 优先级：优先级级别，如高、中、低
  • API端点：包含路径、方法和描述的端点定义列表
步骤2：从SPEC数据生成全面的文档
步骤3：查看生成的文档，包括：
  • 带需求说明的功能文档
  • 带端点详情的API文档
  • 更新后的项目文档文件
  • 若已配置则生成多语言版本
模板性能优化工作流：
步骤1：分析当前模板以收集指标
步骤2：配置优化选项：
  • 先备份：设置为true以在优化前创建备份
  • 应用体积优化：启用以缩减文件大小
  • 应用性能优化：启用以提升加载速度
  • 应用复杂度优化：启用以简化模板结构
  • 保留功能：确保所有功能保持完整
步骤3：执行优化并查看结果：
  • 实现的体积缩减百分比
  • 性能提升指标
  • 备份创建确认
  • 详细优化报告

Language and Localization

语言与本地化

Automatic Language Detection Process:
The system analyzes the project for language indicators using the following methods:
  • File content analysis examining comments and strings
  • Configuration file examination for locale settings
  • System locale detection
  • Directory structure patterns
Multilingual Documentation Structure:
When creating documentation for multiple languages, the system generates:
  • Language-specific documentation directories such as docs/ko for Korean and docs/en for English
  • Language negotiation configuration
  • Automatic redirection setup between language versions
Agent Prompt Localization:
The localization system provides:
  • Language-specific instructions for agents
  • Cultural context adaptations
  • Token cost optimization recommendations for multilingual prompts
自动语言检测流程：
系统通过以下方法分析项目中的语言标识：
  • 检查注释和字符串的文件内容分析
  • 针对区域设置的配置文件检查
  • 系统区域设置检测
  • 目录结构模式
多语言文档结构：
当创建多语言文档时，系统会生成：
  • 特定语言的文档目录，如韩语的docs/ko和英语的docs/en
  • 语言协商配置
  • 语言版本间的自动重定向设置
Agent提示词本地化：
本地化系统提供：
  • 针对Agent的特定语言指令
  • 文化语境适配
  • 多语言提示词的Token成本优化建议

Template Optimization

模板优化

Performance Analysis Process:
Template analysis provides the following metrics:
  • File size and complexity measurements
  • Performance bottleneck identification
  • Optimization opportunity scoring
  • Resource usage patterns
  • Backup recommendations
Intelligent Optimization Process:
The optimization system applies the following techniques:
  • Whitespace and redundancy reduction
  • Template structure optimization
  • Complexity reduction techniques
  • Performance caching improvements
性能分析流程：
模板分析提供以下指标：
  • 文件大小与复杂度测量
  • 性能瓶颈识别
  • 优化机会评分
  • 资源使用模式
  • 备份建议
智能优化流程：
优化系统应用以下技术：
  • 空白字符与冗余内容缩减
  • 模板结构优化
  • 复杂度降低技术
  • 性能缓存改进

Configuration Management

配置管理

Integrated Configuration Status:
The project status includes:
  • Project metadata and type classification
  • Language configuration and associated costs
  • Documentation completion status
  • Template optimization results
  • Module initialization states
Language Settings Update Process:
When updating language settings, configure the following parameters:
  • Conversation language: The language for user-facing responses
  • Agent prompt language: The language for internal agent instructions, often kept as English for cost optimization
  • Documentation language: The language for generated documentation
Updates trigger the following automatic changes:
  • Configuration file modifications
  • Documentation structure updates
  • Template localization adjustments
集成配置状态：
项目状态包含：
  • 项目元数据与类型分类
  • 语言配置及相关成本
  • 文档完成状态
  • 模板优化结果
  • 模块初始化状态
语言设置更新流程：
更新语言设置时，配置以下参数：
  • 对话语言：面向用户的响应语言
  • Agent提示词语言：内部Agent指令的语言，通常保持为英语以优化成本
  • 文档语言：生成文档的语言
更新会触发以下自动变更：
  • 配置文件修改
  • 文档结构更新
  • 模板本地化调整

Advanced Implementation

高级实施

For advanced patterns including custom template development, performance optimization strategies, and integration workflows, see reference.md which covers:
  • Custom Templates: Creating project-type-specific documentation templates
  • Performance Caching: Implementing template caching for improved performance
  • Batch Processing: Efficiently processing multiple templates simultaneously
  • Integration Workflows: Complete project lifecycle and multilingual management
如需了解自定义模板开发、性能优化策略和集成工作流等高级模式，请参阅reference.md，其中涵盖：
  • 自定义模板：创建特定项目类型的文档模板
  • 性能缓存：实现模板缓存以提升性能
  • 批量处理：高效同时处理多个模板
  • 集成工作流：完整项目生命周期与多语言管理

Resources

资源

Configuration Structure

配置结构

Project Configuration Fields:
  • Project name: The display name for the project
  • Project type: Classification such as web_application, mobile_application, or cli_tool
  • Initialization timestamp: When the project was initialized
  • Language configuration: Conversation, agent prompt, and documentation language settings
  • System version: The project management system version
  • Initialization status: Whether all modules are fully initialized
Language Configuration Fields for Each Supported Language:
  • Name: Display name in English
  • Native name: Display name in the native language
  • Code: Language code such as en, ko, ja, or zh
  • Locale: System locale string
  • Agent prompt language: Whether to use English or localized prompts
  • Token cost impact: Percentage increase in token usage for non-English prompts
项目配置字段：
  • 项目名称：项目的显示名称
  • 项目类型：分类，如web_application、mobile_application或cli_tool
  • 初始化时间戳：项目初始化的时间
  • 语言配置：对话、Agent提示词和文档语言设置
  • 系统版本：项目管理系统的版本
  • 初始化状态：所有模块是否已完全初始化
各支持语言的配置字段：
  • 名称：英文显示名称
  • 本地名称：母语显示名称
  • 代码：语言代码，如en、ko、ja或zh
  • 区域设置：系统区域设置字符串
  • Agent提示词语言：是否使用英语或本地化提示词
  • Token成本影响：非英语提示词的Token使用量增长百分比

Performance Metrics

性能指标

Documentation Generation Performance:
  • Complete documentation generation typically completes within 2 to 5 seconds
  • Language detection analysis completes within approximately 500 milliseconds
  • Template optimization duration varies from 10 to 30 seconds depending on project size
  • Configuration updates complete within approximately 100 milliseconds
Memory Usage Characteristics:
  • Base system requires approximately 50MB RAM
  • Large projects may require an additional 10 to 50MB depending on template count
  • Optimization cache uses approximately 5 to 20MB for performance improvements
File Size Impact:
  • Documentation files range from 50 to 200KB per project
  • Optimization backups match the size of original templates
  • Configuration files range from 5 to 10KB for complete project setup
文档生成性能：
  • 完整文档生成通常在2至5秒内完成
  • 语言检测分析约在500毫秒内完成
  • 模板优化时长因项目大小而异，从10至30秒不等
  • 配置更新约在100毫秒内完成
内存使用特性：
  • 基础系统约需50MB内存
  • 大型项目可能需额外10至50MB，具体取决于模板数量
  • 优化缓存为提升性能约使用5至20MB内存
文件大小影响：
  • 每个项目的文档文件大小为50至200KB
  • 优化备份与原始模板大小一致
  • 完整项目设置的配置文件大小为5至10KB

Works Well With

兼容组件

  • moai-foundation-core: Core execution patterns and SPEC-driven development workflows
  • moai-foundation-claude: Claude Code integration and configuration
  • moai-workflow-docs: Unified documentation management
  • moai-workflow-templates: Template optimization strategies
  • moai-library-nextra: Advanced documentation architecture
  • moai-foundation-core：核心执行模式与基于SPEC的开发工作流
  • moai-foundation-claude：Claude Code集成与配置
  • moai-workflow-docs：统一文档管理
  • moai-workflow-templates：模板优化策略
  • moai-library-nextra：高级文档架构