# scShell

**Repository Path**: chenlong_sd/sc-shell

## Basic Information

- **Project Name**: scShell
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-22
- **Last Updated**: 2026-07-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 文档导航

本文档提供 ScShell 项目文档的概览和导航指南。

## 📁 文档结构

```text
scshell/
├── PLAN.md                          # 总体规划（起点）
├── docs/
│   ├── README.md                    # 本文档（文档导航）
│   ├── PRD.md                       # 产品需求文档
│   ├── TECH-DESIGN.md               # 技术设计文档
│   ├── MILESTONES.md                # 里程碑计划
│   ├── WINRM-DESIGN.md              # WinRM 详细设计
│   ├── SECURITY-DESIGN.md           # 安全与凭据设计
│   ├── SSH-SHELL-INTEGRATION.md     # SSH Shell Integration 安装说明
│   ├── TEST-PLAN.md                 # 测试计划
│   ├── DEPLOYMENT-PLAN.md           # 部署与安装计划
│   ├── TERMINAL-REARCHITECTURE-PLAN.md  # 终端重构计划
│   └── ADR.md                       # 架构决策记录

总计：约 4500 行技术文档
```

---

## 🎯 文档阅读路径

### 路径 1：新成员了解项目（推荐顺序）

1. **[PLAN.md](../PLAN.md)** - 从这里开始（10 分钟快速了解）
2. **[PRD.md](./PRD.md)** - 了解产品需求
3. **[MILESTONES.md](./MILESTONES.md)** - 了解开发计划
4. **[TECH-DESIGN.md](./TECH-DESIGN.md)** - 了解技术架构
5. **[ADR.md](./ADR.md)** - 了解关键决策

### 路径 2：参与开发（按模块）

| 模块 | 设计文档 | 相关 ADR |
|------|---------|---------|
| 本地 Shell | TECH-DESIGN § 7 | ADR-004 (ConPTY) |
| SSH | TECH-DESIGN § 8 | ADR-005 (SSH.NET) |
| WinRM | WINRM-DESIGN.md | ADR-007 (Runspace) |
| 凭据管理 | SECURITY-DESIGN.md | ADR-006 (DPAPI) |
| 终端显示 | TERMINAL-REARCHITECTURE-PLAN.md | ADR-002, ADR-008 |

### 路径 3：测试与质量保证

1. [TEST-PLAN.md](./TEST-PLAN.md) - 测试计划总览
2. [TERMINAL-REARCHITECTURE-PLAN.md](./TERMINAL-REARCHITECTURE-PLAN.md) - 验收标准 A01-A15
3. [SECURITY-DESIGN.md § 13](./SECURITY-DESIGN.md) - 安全测试

### 路径 4：部署与发布

1. [DEPLOYMENT-PLAN.md](./DEPLOYMENT-PLAN.md) - 部署计划
2. [TEST-PLAN.md § 11](./TEST-PLAN.md) - 验收标准

## 🔍 快速查找

| 问题 | 参考文档 |
|------|---------|
| 项目是什么？为什么要做？ | PLAN.md § 1-3 |
| 支持哪些功能？ | PRD.md § 7 |
| 当前进展到哪一步？ | MILESTONES.md |
| 为什么选择某个技术？ | ADR.md |
| SSH 连接如何实现？ | TECH-DESIGN.md § 8 |
| SSH 如何启用命令块/退出码/cwd 标记？ | SSH-SHELL-INTEGRATION.md |
| WinRM 怎么设计的？ | WINRM-DESIGN.md |
| 终端显示怎么实现？ | TERMINAL-REARCHITECTURE-PLAN.md |
| 凭据如何加密存储？ | SECURITY-DESIGN.md § 5 |
| 如何测试？有哪些测试用例？ | TEST-PLAN.md |
| 如何打包和部署？ | DEPLOYMENT-PLAN.md |
| 数据库表结构？ | TECH-DESIGN.md § 10 |
| 安全要求和威胁模型？ | SECURITY-DESIGN.md § 3 |
| 性能指标是什么？ | TEST-PLAN.md § 6.1 |

---

## 📊 文档矩阵

| 主题 | 需求 | 设计 | 实施 | 测试 |
|------|------|------|------|------|
| **本地 Shell** | PRD § 7.1.1 | TECH-DESIGN § 7 | MILESTONES M1 | TEST-PLAN § 5.1 |
| **SSH** | PRD § 7.1.2 | TECH-DESIGN § 8 | MILESTONES M3 | TEST-PLAN § 5.2 |
| **WinRM** | PRD § 7.1.2 | WINRM-DESIGN | MILESTONES M4 | TEST-PLAN § 5.3 |
| **凭据管理** | PRD § 7.1.3 | SECURITY-DESIGN | MILESTONES M2 | TEST-PLAN § 5.5 |
| **终端显示** | PRD § 7.1.1 | TERMINAL-REARCHITECTURE | P1-P9 | A01-A15 |

---

## 📝 文档维护原则

1. **架构决策**必须记录到 ADR.md
2. **里程碑变更**必须更新 MILESTONES.md
3. **新功能设计**必须先写设计文档
4. **测试用例**随功能开发同步更新

---

## 📚 外部参考

### 技术栈官方文档
- [WPF Documentation](https://learn.microsoft.com/en-us/dotnet/desktop/wpf/)
- [xterm.js Documentation](https://xtermjs.org/docs/)
- [SSH.NET Documentation](https://github.com/sshnet/SSH.NET/wiki)
- [PowerShell Remoting](https://learn.microsoft.com/en-us/powershell/scripting/learn/remoting/running-remote-commands)

### 协议与标准
- [ANSI/VT100 Sequences](https://vt100.net/docs/vt100-ug/chapter3.html)
- [SSH Protocol (RFC 4253)](https://datatracker.ietf.org/doc/html/rfc4253)
- [OSC 133 Shell Integration](https://gitlab.freedesktop.org/Per_Bothner/specifications/-/blob/master/proposals/semantic-prompts.md)

---

**文档最后更新**：2025-06-06  
**文档总行数**：~4500 行  
**覆盖率**：MVP 功能 100% 有设计文档