跳转到内容

模块命名约定

本规格定义多模块 OpenLogos 项目的文件命名约定。所有 Skill 在生成文件时都必须遵循这些规则。

所有设计文档文件名遵循以下格式:

<module>-<number-or-semantic-name>-<type>.md
  • module:模块标识符——小写字母 + 连字符(如 coreuserpayment
  • 初始项目使用 core- 作为默认模块前缀
  • 新模块在同一目录中创建带其前缀的文件——无需子目录
<module>-01-requirements.md

示例:core-01-requirements.mdadmin-01-requirements.md

<module>-01-feature-specs.md
<module>-00-information-architecture.md
<module>-01-architecture-overview.md
<module>-02-skip-phases-and-interfaces.md
<module>-SXX-<english-slug>.md

示例:core-S01-cli-init.mdadmin-S08-dashboard.md

场景编号全局唯一——由 logos-project.yaml 中的 scenario_counter.next_id 维护。不同模块绝不能从 S01 重新开始。

<module>-SXX-test-cases.md

示例:core-S01-test-cases.mdpayment-S12-test-cases.md

<module>-01-deployment-plan.md
<module>-smoke-test-cases.md

存放于 logos/resources/test/smoke/

按领域拆分,通常在模块间共享(无需模块前缀):

auth.yaml
payment.yaml

按领域拆分,通常在模块间共享:

schema.sql
auth.sql

openlogos status 使用 <moduleId>- 前缀来判定每个模块的阶段完成情况:

  • 当阶段目录中至少存在一个带该模块前缀的文件时,该模块的此阶段才算完成
  • 属于其他模块的文件会被忽略
  • 场景阶段(phase.3-1phase.3-4a)要求逐场景的文件覆盖,而不只是任意文件

多个模块共享同一组目录而不冲突:

logos/resources/prd/1-product-requirements/
├── core-01-requirements.md # core module
├── admin-01-requirements.md # admin module
└── payment-01-requirements.md # payment module

每个模块没有独立子目录——前缀即命名空间。