Skip to content

yisa2/amcontrol

 
 

Repository files navigation

AMControl 项目文档中心

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


目录索引

目录 说明
00-governance 文档治理与命名规范,定义全项目文档的目录命名、文件命名、元数据规范和资产管理规则
01-architecture 架构设计文档,包含系统整体架构图、分层设计、核心模块说明、接口契约和关键技术决策记录(ADR)
02-development 开发指南,包含环境搭建、项目结构说明、编码规范、分支策略、代码审查流程和常见开发问题
03-features 功能模块文档,按业务功能组织,覆盖运动控制、IO 管理、视觉、PLC 通信、权限管理等功能模块的设计与说明
04-testing 测试文档,包含测试策略、测试用例模板、虚拟卡调试指引、集成测试说明
05-operations 运维与部署文档,包含安装包制作、部署说明、数据库迁移、配置管理、日志排查指引
06-user-manual 用户手册,面向操作员和工程师,包含界面操作指引、设备参数配置、报警处理流程
07-release-notes 版本发布记录,按版本号归档变更日志、升级说明和已知问题
08-third-party 第三方依赖说明,记录引入的第三方库、运动控制卡 SDK、协议和许可证信息
09-database-config 数据库与配置文档,包含表结构说明、字段定义、ConfigContext 配置项说明、数据库切换指引
10-simulation 3D 仿真集成文档,包含虚拟设备集成方案、WebSocket 协议、前端仿真规划和网络接入设计
assets 共享资产目录,存放文档中引用的图片、截图、附件和导出文件

快速导航

AMControlWinF 分支

PLC 通信模块


文档维护说明

  • 所有文档均使用 中文 编写,技术术语保留英文原名。
  • 文档命名与目录规范请遵循 00-governance/document-naming-conventions.md
  • 图片和附件统一放置在 assets/ 目录下对应子目录中。
  • 本文档中心为仓库级资产,不隶属于任何单一 .NET 解决方案或项目目录。

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • C# 100.0%