# Software Engineering Docs > 软件工程文档编写指导 skill，提供从项目计划、需求分析、设计、开发、测试到验收各阶段的文档编写规范和模板使用指导。当用户需要编写软件工程相关文档（如可行性分析、项目计划、需求规格说明、测试计划、验收报告等）时触发。 Use when this capability is needed. - Skill: `tomevault-io/software-engineering-docs-2` (Agent Skill, multi-file: 2 files) - Install (CLI): `npx skillmds@latest add tomevault-io/software-engineering-docs-2` - Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/software-engineering-docs-2/raw - Safety review: pending - Works with: Claude Code, Claude.ai, OpenAI Codex - Category: Coding & Dev Tools - Author: tomevault-io (https://skillmd.com/u/tomevault-io) - Updated: 2026-09-17 - Page: https://skillmd.com/skills/tomevault-io/software-engineering-docs-2 --- # Software Engineering Docs 提供软件工程全生命周期各阶段文档的编写指导，涵盖计划阶段、需求阶段、设计阶段、开发阶段、测试阶段和验收阶段的文档模板和规范。 ## 文档阶段索引 - [01 计划阶段](#01-计划阶段) - 可行性分析、项目信息表、实施方案、进度计划 - [02 需求阶段](#02-需求阶段) - 需求规格说明书 - [03 设计阶段](#03-设计阶段) - 功能设计、数据库设计 - [04 开发阶段](#04-开发阶段) - 系统提测申请单 - [05 测试阶段](#05-测试阶段) - 测试用例、测试报告、测试计划 - [06 验收阶段](#06-验收阶段) - 竣工报告、安装维护手册、培训文档、使用手册 ## 文档目录结构 项目中文档按阶段组织，模板文件位于项目根目录: ``` 项目根目录/ ├── 01 计划阶段/ │ ├── 00 可行性分析/ # 可行性分析报告模板和示例 │ ├── 01 项目信息表/ │ ├── 02 项目实施方案-PPT版/ │ ├── 03 项目实施方案-Word版/ │ ├── 04 项目实施进度计划/ │ └── 05 项目实施进度简表/ ├── 02 需求阶段/ │ └── 需求规格说明书/ ├── 03 设计阶段/ │ ├── 功能设计说明书/ │ └── 数据库设计说明书/ ├── 04 开发阶段/ │ └── 系统提测申请单/ ├── 05 测试阶段/ │ ├── 01 测试用例/ │ ├── 02 测试报告/ │ └── 03 测试计划/ ├── 06 验收阶段/ │ ├── 01 系统竣工报告/ │ ├── 02 安装维护手册/ │ ├── 03 培训文档/ │ └── 04 使用手册/ └── 99 其他模板/ ├── 工时统计表/ ├── 会议纪要/ ├── 项目进度简报/ ├── 项目月报/ └── 项目周报/ ``` ## 01 计划阶段 ### 可行性分析 (01 计划阶段/00 可行性分析/) **目的**: 评述软件开发项目在技术上、经济上和社会因素上的可行性 **主要内容**: - 项目背景与目的 - 可行性分析的前提条件 - 可行性分析（技术、经济、操作） - 结论意见 **模板文件**: `01 计划阶段/00 可行性分析/可行性分析 - 模板.docx` ### 项目信息表 (01 计划阶段/01 项目信息表/) **目的**: 记录项目基本信息 ### 项目实施方案 (01 计划阶段/02 项目实施方案-PPT版/, 03 项目实施方案-Word版/) **目的**: 详细说明项目实施方案 **内容**: 项目目标、范围、方法、资源配置、风险分析 ### 项目实施进度计划 (01 计划阶段/04 项目实施进度计划/) **目的**: 制定项目具体计划 **内容**: 各部分工作负责人员、开发进度、经费预算、硬件软件资源 ## 02 需求阶段 ### 需求规格说明书 (02 需求阶段/需求规格说明书/) **目的**: 详细说明软件的功能、性能、用户界面及运行环境 **主要内容**: - 功能需求 - 性能需求 - 接口需求（用户接口、硬件接口、软件接口、通信接口） - 数据需求 - 其他需求（安全、可靠性、保密等） ## 03 设计阶段 ### 功能设计说明书 (03 设计阶段/功能设计说明书/) **目的**: 概要设计阶段成果 **内容**: 功能分配、模块划分、程序总体结构、输入输出设计、接口设计、运行设计、错误处理设计 ### 数据库设计说明书 (03 设计阶段/数据库设计说明书/) **目的**: 说明数据库设计 **内容**: 概念结构设计、逻辑结构设计、物理结构设计 ## 04 开发阶段 ### 系统提测申请单 (04 开发阶段/系统提测申请单/) **目的**: 开发完成后提交测试的申请 ## 05 测试阶段 ### 测试用例 (05 测试阶段/01 测试用例/) **目的**: 记录测试用例 ### 测试报告 (05 测试阶段/02 测试报告/) **目的**: 测试工作完成后的分析报告 ### 测试计划 (05 测试阶段/03 测试计划/) **目的**: 为集成测试和验收测试制订实施计划 **内容**: 测试内容、进度、条件、人员、测试用例选取原则、结果允许偏差 ## 06 验收阶段 ### 系统竣工报告 (06 验收阶段/01 系统竣工报告/) **目的**: 项目完成后的竣工报告 ### 安装维护手册 (06 验收阶段/02 安装维护手册/) **目的**: 软件系统说明、程序模块说明、操作环境、支持软件说明、维护过程 ### 培训文档 (06 验收阶段/03 培训文档/) **目的**: 用户培训材料 ### 使用手册 (06 验收阶段/04 使用手册/) **目的**: 描述软件功能、性能和用户界面，为操作人员提供运行知识 ## 文档编写通用原则 ### 完整性 - 覆盖所有必要章节 - 内容详实准确 - 无关键信息遗漏 ### 规范性 - 标题层级清晰 - 格式统一规范 - 术语使用一致 ### 可追溯性 - 版本记录清晰 - 编写审核人员明确 - 日期版本可查 ## 使用文档模板 文档模板为 `.docx` 格式，使用时: 1. 定位对应阶段的模板文件 2. 复制模板到目标位置 3. 根据项目实际情况填充内容 4. 使用 docx skill 进行编辑和格式化 **模板路径格式**: `01 计划阶段/00 可行性分析/可行性分析 - 模板.docx` ## 参考资源 - [writing-guidelines.md](../writing-guidelines.md) - 文档编写通用规范（封面要求、正文结构、术语规范、审批流程） - 详细文档模板请查看各阶段目录下的 `.docx` 文件 - 配合 docx skill 使用可实现文档的创建和编辑 --- > Source: [yanhaoluo0/technical-proposal-expert-writing-skill](https://github.com/yanhaoluo0/technical-proposal-expert-writing-skill) — distributed by [TomeVault](https://tomevault.io).