{
  "schemaVersion": "0.11.0",
  "canonical": "https://www.pystone.net/notes/software-documentation-examples/",
  "atlas": "https://www.pystone.net/?node=software-documentation-examples#knowledge-atlas",
  "markdown": "https://www.pystone.net/notes/software-documentation-examples.md",
  "context": "https://www.pystone.net/notes/software-documentation-examples.context.json",
  "knowledgeVersion": "224c990773de.5fa8af6e39fa",
  "build": {
    "siteCommit": "224c990773de166d23a886306577dd90379529ce",
    "notesCommit": "5fa8af6e39fa3891d1b9b4832bfa6c4e0ecaaf0a",
    "builtAt": "1970-01-01T00:00:00.000Z",
    "version": "224c990773de.5fa8af6e39fa"
  },
  "id": "note:software-documentation-examples",
  "slug": "software-documentation-examples",
  "title": "软件文档示例",
  "type": "note",
  "visibility": "public",
  "idStability": "rename-stable",
  "author": {
    "name": "Perrin Yong",
    "profile": "https://www.pystone.net/profile/"
  },
  "publisher": {
    "name": "Perrin Yong",
    "profile": "https://www.pystone.net/profile/"
  },
  "aliases": [],
  "summary": "软件文档示例 创建时间：2021/9/7 17:14",
  "contentRole": "unspecified",
  "isMoc": false,
  "mocRecognition": "none",
  "generated": false,
  "attribution": "unspecified",
  "domain": "10-计算机、信息技术与工程",
  "tags": [],
  "mocs": [],
  "contentHash": "bc9ed10b29102590936962c2d43ba3efa2a2b28533cbad374c2d116b79d54b35",
  "assets": [
    {
      "reference": "assets/0002 - 软件文档示例__resource-001-012c4a43537c.png",
      "url": "/media/63863e657fa478c8198f.png",
      "mediaType": "image/png",
      "contentHash": "63863e657fa478c8198f67edfb1e21a63eb7e18f70f4ea7a990c27f7fff07416",
      "byteLength": 15666,
      "width": 332,
      "height": 638
    },
    {
      "reference": "assets/0002 - 软件文档示例__resource-002-91cbb93d1e4b.png",
      "url": "/media/039980c7c3a98d68a311.png",
      "mediaType": "image/png",
      "contentHash": "039980c7c3a98d68a311cdb8e39d46790151fec5e3371b1156661ab603bc794c",
      "byteLength": 17363,
      "width": 637,
      "height": 455
    },
    {
      "reference": "assets/0002 - 软件文档示例__resource-003-3bd9b1836255.png",
      "url": "/media/55275165c60d80a26b6e.png",
      "mediaType": "image/png",
      "contentHash": "55275165c60d80a26b6e75a84eaf29b628a5249c1e56f85cffaced5ebba68938",
      "byteLength": 73557,
      "width": 918,
      "height": 273
    },
    {
      "reference": "assets/0002 - 软件文档示例__resource-004-e1f3da6b66d9.png",
      "url": "/media/ca6166266f26e77f1251.png",
      "mediaType": "image/png",
      "contentHash": "ca6166266f26e77f12511012dff90ecb3c336b748e8eb848fa2487b524af491c",
      "byteLength": 29382,
      "width": 887,
      "height": 206
    },
    {
      "reference": "assets/0002 - 软件文档示例__resource-005-896f0dd18685.jpg",
      "url": "/media/b186902b6e1bb8709243.jpg",
      "mediaType": "image/jpeg",
      "contentHash": "b186902b6e1bb87092438936159b79ffc1c063f3ccfbacb50c73291a6c7d58ac",
      "byteLength": 173708,
      "width": 1525,
      "height": 469
    },
    {
      "reference": "assets/0002 - 软件文档示例__resource-006-8761d8dee397.png",
      "url": "/media/7ecaaaf9b66fe3b5dc67.png",
      "mediaType": "image/png",
      "contentHash": "7ecaaaf9b66fe3b5dc677de171e5f730750e949c0184979b405ba22225e0f6bc",
      "byteLength": 55172,
      "width": 808,
      "height": 864
    },
    {
      "reference": "assets/0002 - 软件文档示例__resource-008-37ac7ba38301.png",
      "url": "/media/186ed76f8ba02a15a773.png",
      "mediaType": "image/png",
      "contentHash": "186ed76f8ba02a15a7738bd5ed3adbb1a9d5db0cf8514febad00e7b51532f2ca",
      "byteLength": 32785,
      "width": 472,
      "height": 506
    },
    {
      "reference": "assets/0002 - 软件文档示例__resource-007-5e47a05cb1fc.png",
      "url": "/media/88329a73eeaa9e09540a.png",
      "mediaType": "image/png",
      "contentHash": "88329a73eeaa9e09540adb79bbc2724a1dd2f0458a7123d393aca4f59272bfd4",
      "byteLength": 27171,
      "width": 284,
      "height": 701
    },
    {
      "reference": "assets/0002 - 软件文档示例__resource-009-3f72fa293bc6.png",
      "url": "/media/9219d88ae03047d53644.png",
      "mediaType": "image/png",
      "contentHash": "9219d88ae03047d5364479f0fe8f74533bdb0170ac503faef9ab8fe69598f985",
      "byteLength": 8748,
      "width": 329,
      "height": 425
    },
    {
      "reference": "assets/0002 - 软件文档示例__resource-010-1768855a922b.png",
      "url": "/media/915497ac120a833a8ce3.png",
      "mediaType": "image/png",
      "contentHash": "915497ac120a833a8ce3b91f5c7c6b605a040213c6fd5381c4a857c59071425e",
      "byteLength": 20614,
      "width": 335,
      "height": 459
    }
  ],
  "headings": [
    {
      "depth": 1,
      "text": "软件文档示例",
      "anchor": "软件文档示例",
      "citation": "https://www.pystone.net/notes/software-documentation-examples/#%E8%BD%AF%E4%BB%B6%E6%96%87%E6%A1%A3%E7%A4%BA%E4%BE%8B"
    }
  ],
  "claims": [],
  "outgoing": [],
  "incoming": [
    {
      "id": "note:software-engineering-and-quality",
      "title": "软件工程与质量保障",
      "url": "https://www.pystone.net/notes/software-engineering-and-quality/",
      "atlas": "https://www.pystone.net/?node=software-engineering-and-quality#knowledge-atlas",
      "label": "软件工程与质量保障",
      "origin": "explicit",
      "humanReviewed": true,
      "context": "软件工程与项目管理中的“软件文档示例”导航项",
      "citation": "https://www.pystone.net/notes/software-engineering-and-quality/#%E8%BD%AF%E4%BB%B6%E5%B7%A5%E7%A8%8B%E4%B8%8E%E9%A1%B9%E7%9B%AE%E7%AE%A1%E7%90%86"
    }
  ],
  "contentMarkdown": "# 软件文档示例\n> 创建时间：2021/9/7 17:14\n\n<https://www.cnblogs.com/lishanlei/p/9467407.html>\n\n<https://wenku.baidu.com/view/a03e0188d0d233d4b14e69ae.html>\n\n<https://zhuanlan.zhihu.com/p/59533572?utm_source=wechat_session>\n\n<https://www.cnblogs.com/Gavin_Liu/archive/2009/04/02/1428033.html>\n\n![](assets/0002 - 软件文档示例__resource-001-012c4a43537c.png)\n\n* * *\n\n<http://www.woshipm.com/user-research/4326319.html>\n\n前言 - 文档目的、文档读者、术语定义；\n\n介绍-  产品概述、产品功能描述、背景意义\n\n系统概述 - 系统架构图，功能清单，业务流程图\n\n系统操作 -\n\n![](assets/0002 - 软件文档示例__resource-002-91cbb93d1e4b.png)\n\n* * *\n\n<https://bibichuan.github.io/posts/ce5650a0.html>\n\n  * 引言\n\n    * 编写目的\n\n    * 背景\n\n    * 相关术语\n\n  * 软件概述\n\n    * 目标\n\n    * 功能\n\n  * 运行环境\n\n    * 硬件\n\n    * 软件\n\n  * 安装与恢复\n\n    * 安装和初始化\n\n    * 出错和恢复\n\n  * 操作说明\n\n    * 运行表\n\n    * 运行步骤\n\n      * 运行控制\n\n      * 操作信息\n\n  * 非常规过程\n\n  * 用户操作举例\n\n编写目的：\n\n![](assets/0002 - 软件文档示例__resource-003-3bd9b1836255.png)\n\n运行表：\n\n![](assets/0002 - 软件文档示例__resource-004-e1f3da6b66d9.png)\n\n* * *\n\n![](assets/0002 - 软件文档示例__resource-005-896f0dd18685.jpg)\n\n* * *\n\n<https://computersciencewiki.org/index.php/User_documentation>\n\n  * Minimum hardware and software requirements\n\n  * Installation guide\n\n  * How to start the system\n\n  * How to use different features of the system\n\n  * Screenshots explaining main features of the system\n\n  * Example inputs and outputs\n\n  * Explanations of error messages and troubleshooting guides\n\n  * Information to contact the developer of the system if an undocumented question arises\n\n* * *\n\nGoogle Earth:<https://support.google.com/earth/?page=guide_toc.cs#topic=7364880>\n\n![](assets/0002 - 软件文档示例__resource-006-8761d8dee397.png)\n\n* * *\n\n![](assets/0002 - 软件文档示例__resource-008-37ac7ba38301.png)\n\n* * *\n\n分角色的User Guide:\n\n<http://docs.autodesk.com/TOPOBSCLNT/2010/ENU/Autodesk%20Topobase%202010%20User%20Documentation/index.html?url=WSfacf1429558a55de9af080101d7e8b304-7c61.htm,topicNumber=d0e342>\n\n![](assets/0002 - 软件文档示例__resource-007-5e47a05cb1fc.png)\n\n* * *\n\nTeamCity<https://www.jetbrains.com/help/teamcity/teamcity-documentation.html>\n\n![](assets/0002 - 软件文档示例__resource-009-3f72fa293bc6.png)\n\n* * *\n\nCircle CI\n\n![](assets/0002 - 软件文档示例__resource-010-1768855a922b.png)\n"
}