Skip to content

ammm56/amcontrol

Repository files navigation

AMControl 项目文档中心

本目录是 ammm56/amcontrol 仓库的仓库级文档中心,集中管理所有项目相关文档。文档中心作为仓库级资产,独立于具体的 .NET 解决方案和项目,便于长期维护与 Copilot/本地开发使用。


目录索引

目录 说明
00-governance 文档治理目录,定义命名规范、长期维护规则、事实来源优先级和索引使用方式
01-architecture 架构设计文档,偏长期稳定的分层边界、核心约束、接口契约和 ADR
02-development 开发指南,偏当前活跃分支的开发基线、工程环境与协作方式
03-features 功能模块文档,按业务功能组织,区分当前实现说明与历史规划/接口说明
04-testing 测试文档,包含测试策略、测试用例模板、虚拟卡调试指引、集成测试说明
05-operations 运维与部署文档,面向安装、升级、排障与现场维护操作,不作为当前实现事实总览
06-user-manual 用户手册,面向操作使用与培训,不作为当前实现事实或开发状态的优先来源
07-release-notes 版本发布与开发进展目录,区分正式发布记录与当前活跃分支进展
08-third-party 第三方依赖说明,记录引入的第三方库、运动控制卡 SDK、协议和许可证信息
09-database-config 数据库与配置文档,优先记录当前表结构事实、表名映射和配置来源,历史设计说明仅作对照
10-simulation 3D 仿真集成文档,当前以历史规划和长期设计资料为主
assets 共享资产目录,存放文档中引用的图片、截图、附件和导出文件

快速导航

AMControlWinF 分支

PLC 通信模块


文档维护说明

  • 所有文档均使用 中文 编写,技术术语保留英文原名。
  • 文档命名与目录规范请遵循 00-governance/document-naming-conventions.md
  • 文档的长期维护规则、事实来源优先级和实现/规划文档的并存方式,请遵循 00-governance/document-maintenance-rules.md
  • 当实现文档与规划文档并存时,默认优先读取“当前实现说明”类文档;规划文档仅用于背景和历史对照。
  • 当前事实优先参考代码、02-development07-release-notes 和对应专题的“实现说明”文档。
  • 长期设计、架构意图和历史规划优先参考 01-architecture 及已明确标记为“历史规划/归档”的文档。
  • 若未来新增 UI 主线、后端形态、宿主方案或整体迁移到 .NET 10,请优先参考 01-architecture/multi-frontend-cross-platform-evolution.md 判断文档边界与新增文档方式。
  • 图片和附件统一放置在 assets/ 目录下对应子目录中。
  • 本文档中心为仓库级资产,不隶属于任何单一 .NET 解决方案或项目目录。

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages