面向 Sentaurus TCAD 的工程化知识库站点,基于官方手册整理为结构化、可检索、可持续维护的文档。
- VitePress 1.x
- 本地搜索
- GitHub Pages 部署
docs/: 当前正在维护的 VitePress 站点内容docs/.vitepress/: 站点配置、主题扩展与构建产物目录docs/public/: 静态资源
当前开发重点不是做新的前端框架功能,而是持续建设 docs/ 下的知识库内容与站点可维护性。
- 第一优先级:完善
docs/manuals/中的核心流程手册,尤其是 SWB 章节化内容 - 第二优先级:补全导航、交叉链接、图片资源、检索体验和主题细节
- 第三优先级:补强
docs/guide/中的写作规范、内容路线图与协作说明
当前协作原则:
- 以 VitePress 站点为唯一有效产品形态
- 优先做文档质量、结构一致性和可长期维护的改动
- 避免引入与当前目标无关的大型前端重构
| 来源 | 位置 |
|---|---|
| User Guides (PDF) | ~/Sentaurus/Sentaurus_Help/PDFManual/data/ |
| Python API Docs | ~/Sentaurus/Sentaurus_Help/swb_api/ |
| Applications Library | 虚拟机 /opt/synopsys/.../Applications_Library/ |
npm install npm run dev默认启动 VitePress 本地开发服务器。
npm run build npm run preview构建产物输出到 docs/.vitepress/dist/,部署目标为 GitHub Pages。
- 所有新增内容默认放在
docs/下;不要重新引入独立 SPA 或第二套站点入口 - 改文档时优先遵循 docs/guide/writing-guide.md 中已有规范
- 新章节文件名使用小写加连字符,章节页延续
ch{n}-*.md形式 - 图片统一放到
docs/public/images/{tool}/{chapter}/,不要散落在其他目录 - 站点导航、侧边栏、搜索相关改动统一在 config.ts 收口
- 提交前至少执行一次
npm run build,确保文档、链接和配置没有把站点构建打坏 - 修改内容时尽量保持“来源可追溯、术语统一、结构一致”,减少只改一半的占位式提交
- 先确认要改的是内容、结构还是主题配置。
- 内容类改动优先检查 content-plan.md 和对应手册目录。
- 如果新增页面,同步补侧边栏、概览页入口和所需图片资源。
- 本地执行
npm run build验证后再提交。
- 启动 SProcess 第 3 轮专项深化:完成最小工艺流程样例(M1)
- 推进 SProcess 模型专题:注入/扩散/氧化与应力(M2)
- 继续深化 SWB Chapter 6~12,补齐正文翻译、图示、命令示例与排障说明
- 为核心工具概览页补充“最小工作流”“常见坑点”“输入输出速查”
- 建立跨工具链路说明,优先补
SProcess -> SMesh -> SDevice -> SVisual - 统一核对图片资源路径、图号、alt 文本与图题格式
- 补强
docs/guide/中的协作规范、页面模板和写作示例 - 逐步清理占位页,让“有入口但无内容”的页面减少到最低
- 已完成:VitePress 站点已稳定运行,旧 Vue SPA 原型已移除
- 已完成:GitHub Pages 构建链路可用,
npm run build可通过 - 持续进行:导航、主题细节、本地搜索和资源组织持续优化
- 已完成:
Batch A核心工具的第一轮概览页和第二轮骨架页 - 进行中:SProcess 第 3 轮专项深化(已完成
sprocess_ug.pdfW-2024.09 目录梳理 + M1 最小流程样例) - 已完成:SWB Chapter 1~5 的重点建设与最近一轮修订
- 进行中:SWB Chapter 6~12 深化
- 待推进:
Batch B与Batch C内容从骨架页走向可用页
- 推进 SProcess 里程碑 M2(注入/扩散/氧化与应力模型专题)。
- 进入 SProcess 里程碑 M3(结构/网格联动与版图驱动入口)。
- 并行保持 SWB Chapter 6~12 的章节化推进节奏。
- 内容开发优先在
docs/manuals/与docs/guide/下进行 - 站点导航与搜索配置位于
docs/.vitepress/config.ts - 旧的 Vue SPA 原型已移除,仓库当前仅维护 VitePress 站点
MIT