软件文档示例

创建时间：2021/9/7 17:14

https://www.cnblogs.com/lishanlei/p/9467407.html

https://wenku.baidu.com/view/a03e0188d0d233d4b14e69ae.html

https://zhuanlan.zhihu.com/p/59533572?utm_source=wechat_session

https://www.cnblogs.com/Gavin_Liu/archive/2009/04/02/1428033.html

---

http://www.woshipm.com/user-research/4326319.html

前言 - 文档目的、文档读者、术语定义；

介绍- 产品概述、产品功能描述、背景意义

系统概述 - 系统架构图，功能清单，业务流程图

系统操作 -

---

https://bibichuan.github.io/posts/ce5650a0.html

• 引言

  • 编写目的

  • 背景

  • 相关术语

• 软件概述

  • 目标

  • 功能

• 运行环境

  • 硬件

  • 软件

• 安装与恢复

  • 安装和初始化

  • 出错和恢复

• 操作说明

  • 运行表

  • 运行步骤

    • 运行控制

    • 操作信息

• 非常规过程

• 用户操作举例

编写目的：

运行表：

---

---

https://computersciencewiki.org/index.php/User_documentation

• Minimum hardware and software requirements

• Installation guide

• How to start the system

• How to use different features of the system

• Screenshots explaining main features of the system

• Example inputs and outputs

• Explanations of error messages and troubleshooting guides

• Information to contact the developer of the system if an undocumented question arises

---

Google Earth:https://support.google.com/earth/?page=guide_toc.cs#topic=7364880

---

---

分角色的User Guide:

http://docs.autodesk.com/TOPOBSCLNT/2010/ENU/Autodesk%20Topobase%202010%20User%20Documentation/index.html?url=WSfacf1429558a55de9af080101d7e8b304-7c61.htm,topicNumber=d0e342

---

TeamCityhttps://www.jetbrains.com/help/teamcity/teamcity-documentation.html

---

Circle CI