Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
architecture
architecture
 
 
guides
guides
 
 
progress
progress
 
 
reports
reports
 
 
DOCUMENTATION_MANAGEMENT_PLAN.md
DOCUMENTATION_MANAGEMENT_PLAN.md
 
 
README.md
README.md
 
 

README.md

📚 Bit HCI 文档中心

所属项目：Bit HCI - 统一人机交互基础设施
版本：v0.0.1
最后更新：2025-10-12

欢迎来到 Bit HCI 项目的文档中心。本目录包含项目的所有技术文档、开发指南和进度报告。

📋 文档导航

🏗️ 架构文档 - Architecture

核心技术架构与设计文档

文档 说明 链接
Bit HCI 技术架构 整体架构设计与技术选型 BIT_HCI_ARCHITECTURE.md
通用编译器架构参考 编译器设计理论与最佳实践 COMPILER_ARCHITECTURE_GUIDE.md

内容包括：

  • 项目背景与核心定位
  • 技术基础（C++ + Vulkan）
  • Bit、BitUI 与 Bit HCI 的关系
  • 编译器模块化架构设计
  • 多形态支持（CLI/GUI/Web）
  • 渐进式迁移策略

📖 开发指南 - Guides

实用的开发指南与教程

文档 说明 链接
统一构建系统指南 ⭐ 完整的构建系统使用文档 UNIFIED_BUILD_SYSTEM.md
统一构建系统迁移指南 从旧系统迁移指导 MIGRATION_TO_UNIFIED_BUILD.md
Examples 组件与 Native 集成 组件开发指南 EXAMPLES_NATIVE_INTEGRATION.md
BitUI 编译器开发指南 编译器实现的详细文档 BitUI_Compiler_Guide.md
编译器 README 编译器使用说明 compiler/README.md
Push 脚本指南 推送脚本使用说明 scripts/PUSH_SCRIPT_GUIDE.md

内容包括：

  • 统一构建系统使用（⭐ 新增）
  • 组件开发流程
  • 词法分析器（Lexer）设计
  • 语法分析器（Parser）实现
  • AST 设计与访问者模式
  • 代码生成与优化
  • 新语法扩展流程

📊 项目报告 - Reports

项目的各类报告和总结文档

报告 说明 生成时间 链接
统一构建系统实施报告 ⭐ 技术实施详情与架构设计 2025-10-12 UNIFIED_BUILD_SYSTEM_2025-10-12.md
统一构建系统中文总结 中文详细总结与使用指南 2025-10-12 UNIFIED_BUILD_SUMMARY_CN_2025-10-12.md
构建系统验证报告 完整测试验证报告 2025-10-12 BUILD_SYSTEM_VERIFICATION_2025-10-12.md
组件加载路径修复报告 路径问题修复详情 2025-10-12 COMPONENT_LOADING_FIX_2025-10-12.md
最终状态报告 项目完整状态总结 2025-10-12 FINAL_STATUS_2025-10-12.md
文档缺口分析报告 文档一致性审查 2025-10-12 DOCUMENTATION_GAP_ANALYSIS_2025-10-12.md
文档一致性检查报告 文档冲突修正报告 2025-10-11 DOCUMENTATION_CONSISTENCY_REPORT.md
文档更新总结 文档整合总结 2025-10-11 DOCUMENTATION_UPDATE_SUMMARY.md
术语修正报告 BitUI 定位修正报告 2025-10-11 TERMINOLOGY_CORRECTION_REPORT.md

报告内容：

  • 统一构建系统实施（⭐ 新增）
  • 性能对比与优化
  • 完整测试验证
  • 版本号统一
  • 项目关系明确
  • 技术栈职责清晰
  • 文档交叉引用完善
  • 术语使用一致性

🚀 开发进度 - Progress

项目开发进度与里程碑追踪

文档 说明 链接
开发进度详细 滚动记录项目进展 PROGRESS.md

进度内容：

  • 已完成的里程碑
  • 进行中的任务
  • 下一步计划
  • 编译器模块状态
  • 构建系统状态

🗂️ 文档结构

docs/
├── README.md                      # 本文件：文档中心导航
│
├── architecture/                  # 架构文档
│   ├── BIT_HCI_ARCHITECTURE.md   # Bit HCI 技术架构
│   └── COMPILER_ARCHITECTURE_GUIDE.md  # 编译器架构参考
│
├── guides/                        # 开发指南
│   └── BitUI_Compiler_Guide.md   # BitUI 编译器开发指南
│
├── reports/                       # 项目报告
│   ├── DOCUMENTATION_CONSISTENCY_REPORT.md    # 文档一致性报告
│   ├── DOCUMENTATION_UPDATE_SUMMARY.md        # 文档更新总结
│   └── TERMINOLOGY_CORRECTION_REPORT.md       # 术语修正报告
│
└── progress/                      # 开发进度
    └── PROGRESS.md                # 开发进度详细

🎯 快速导航

新手入门

  1. 📖 先阅读 Bit HCI 技术架构
  2. 🔍 了解 项目关系和定位
  3. 💻 查看 开发进度

编译器开发

  1. 📚 阅读 通用编译器架构参考
  2. 🛠️ 查看 BitUI 编译器开发指南
  3. 🚀 参考 编译器 README

项目贡献

  1. 📋 查看 开发进度
  2. 📝 阅读相关报告了解项目规范
  3. 🔧 参考开发指南进行开发

📖 用户文档（规划中）

以下用户文档正在编写中：

快速开始

  • 环境配置指南
  • 第一个 BitUI 程序
  • 编译与运行教程

语言基础

  • BitUI 语法概览
  • 组件系统详解
  • 响应式信号机制
  • 事件处理

高级特性

  • 样式系统
  • 状态管理
  • 组件通信
  • 性能优化技巧

API 参考

  • 内置组件列表
  • 运行时 API
  • 编译器选项
  • 配置文件格式

常见问题（FAQ）

  • 安装问题
  • 编译错误解决
  • 运行时问题排查
  • 性能调优建议

🔗 相关资源

项目文档

外部资源

📝 文档贡献指南

添加新文档

  1. 确定文档类型

    • 架构设计 → architecture/
    • 开发指南 → guides/
    • 项目报告 → reports/
    • 开发进度 → progress/

  2. 遵循命名规范

    • 使用 PascalCase 或 snake_case
    • 文件名要有意义
    • 添加 .md 扩展名

  3. 更新导航

    • 在本 README.md 中添加链接
    • 更新相关交叉引用

文档编写规范

  • ✅ 使用清晰的标题层次
  • ✅ 添加目录（如需要）
  • ✅ 提供代码示例
  • ✅ 包含版本和日期信息
  • ✅ 添加交叉引用链接
  • ✅ 使用 Markdown 格式

🔄 文档维护

定期更新

  • 开发进度每周更新
  • 技术架构随需求变更
  • 报告按实际情况生成

版本管理

  • 文档版本与项目版本同步
  • 重大更新需要记录变更日志
  • 过时文档移至 archived/ 目录

📮 反馈与建议

如果你发现文档中的问题或有改进建议，请：

  • 提交 Issue
  • 发起 Pull Request
  • 联系项目维护者

维护者：Bit Project 团队
项目主页：Bit HCI
最后更新：2025-10-12
文档版本：v0.0.1