UNPKG

innomind-vita

Version:

InnoMind Vita - AI-Powered Industrial Software Platform

78 lines (64 loc) • 1.85 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# InnoMind Vita 文档中心 ## 文档结构 ``` docs/ ├── api/ # API文档 │ ├── engines/ # 引擎API │ ├── platform/ # 平台API │ └── plugins/ # 插件API ├── guides/ # 开发指南 │ ├── getting-started/ # 入门指南 │ ├── architecture/ # 架构设计 │ └── best-practices/ # 最佳实践 ├── specs/ # 技术规范 │ ├── code/ # 代码规范 │ ├── commit/ # 提交规范 │ └── api/ # API设计规范 └── examples/ # 示例代码 ``` ## 文档规范 ### 1. 文件命名 - 使用小写字母和连字符 - 文件名应清晰描述内容 - 示例：`api-design-guide.md` ### 2. 目录组织 - 按功能模块分类 - 保持层级清晰 - 避免过深嵌套（最多3层） ### 3. 文档格式 - 使用Markdown格式 - 遵循中文文案排版指北 - 代码块需指定语言 ### 4. 文档内容 - 标题层级最多4级 - 必须包含简介 - 示例代码需有注释 - 专有名词需解释 ### 5. API文档规范 - 使用TypeDoc格式注释 - 必须包含参数说明 - 必须有返回值说明 - 建议提供示例代码 ### 6. 注释规范 - 类和接口必须注释 - 公共方法必须注释 - 复杂逻辑需要注释 - 使用JSDoc规范 ### 7. 示例代码规范 - 完整可运行 - 简洁清晰 - 包含必要注释 - 遵循代码规范 ## 文档维护 1. 文档更新 - 代码变更必须更新文档 - 定期检查文档有效性 - 及时修复文档错误 2. 版本控制 - 文档版本与代码同步 - 重要更新需要说明 - 保留更新历史 3. 评审流程 - 重要文档需要评审 - 收集读者反馈 - 持续改进优化