Menu
软件工程文档编写指导 skill，提供从项目计划、需求分析、设计、开发、测试到验收各阶段的文档编写规范和模板使用指导。当用户需要编写软件工程相关文档（如可行性分析、项目计划、需求规格说明、测试计划、验收报告等）时触发。
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
| name | software-engineering-docs |
| description | 软件工程文档编写指导 skill，提供从项目计划、需求分析、设计、开发、测试到验收各阶段的文档编写规范和模板使用指导。当用户需要编写软件工程相关文档（如可行性分析、项目计划、需求规格说明、测试计划、验收报告等）时触发。 |
提供软件工程全生命周期各阶段文档的编写指导，涵盖计划阶段、需求阶段、设计阶段、开发阶段、测试阶段和验收阶段的文档模板和规范。
项目中文档按阶段组织，模板文件位于项目根目录:
项目根目录/
├── 01 计划阶段/
│ ├── 00 可行性分析/ # 可行性分析报告模板和示例
│ ├── 01 项目信息表/
│ ├── 02 项目实施方案-PPT版/
│ ├── 03 项目实施方案-Word版/
│ ├── 04 项目实施进度计划/
│ └── 05 项目实施进度简表/
├── 02 需求阶段/
│ └── 需求规格说明书/
├── 03 设计阶段/
│ ├── 功能设计说明书/
│ └── 数据库设计说明书/
├── 04 开发阶段/
│ └── 系统提测申请单/
├── 05 测试阶段/
│ ├── 01 测试用例/
│ ├── 02 测试报告/
│ └── 03 测试计划/
├── 06 验收阶段/
│ ├── 01 系统竣工报告/
│ ├── 02 安装维护手册/
│ ├── 03 培训文档/
│ └── 04 使用手册/
└── 99 其他模板/
├── 工时统计表/
├── 会议纪要/
├── 项目进度简报/
├── 项目月报/
└── 项目周报/
目的: 评述软件开发项目在技术上、经济上和社会因素上的可行性
主要内容:
模板文件: 01 计划阶段/00 可行性分析/可行性分析 - 模板.docx
目的: 记录项目基本信息
目的: 详细说明项目实施方案
内容: 项目目标、范围、方法、资源配置、风险分析
目的: 制定项目具体计划
内容: 各部分工作负责人员、开发进度、经费预算、硬件软件资源
目的: 详细说明软件的功能、性能、用户界面及运行环境
主要内容:
目的: 概要设计阶段成果
内容: 功能分配、模块划分、程序总体结构、输入输出设计、接口设计、运行设计、错误处理设计
目的: 说明数据库设计
内容: 概念结构设计、逻辑结构设计、物理结构设计
目的: 开发完成后提交测试的申请
目的: 记录测试用例
目的: 测试工作完成后的分析报告
目的: 为集成测试和验收测试制订实施计划
内容: 测试内容、进度、条件、人员、测试用例选取原则、结果允许偏差
目的: 项目完成后的竣工报告
目的: 软件系统说明、程序模块说明、操作环境、支持软件说明、维护过程
目的: 用户培训材料
目的: 描述软件功能、性能和用户界面，为操作人员提供运行知识
文档模板为 .docx 格式，使用时:
模板路径格式: 01 计划阶段/00 可行性分析/可行性分析 - 模板.docx
.docx 文件