{
  "schemaVersion": "0.11.0",
  "canonical": "https://www.pystone.net/notes/chatgpt-software-engineering-docs/",
  "atlas": "https://www.pystone.net/?node=chatgpt-software-engineering-docs#knowledge-atlas",
  "markdown": "https://www.pystone.net/notes/chatgpt-software-engineering-docs.md",
  "context": "https://www.pystone.net/notes/chatgpt-software-engineering-docs.context.json",
  "knowledgeVersion": "224c990773de.5fa8af6e39fa",
  "build": {
    "siteCommit": "224c990773de166d23a886306577dd90379529ce",
    "notesCommit": "5fa8af6e39fa3891d1b9b4832bfa6c4e0ecaaf0a",
    "builtAt": "1970-01-01T00:00:00.000Z",
    "version": "224c990773de.5fa8af6e39fa"
  },
  "id": "note:chatgpt-software-engineering-docs",
  "slug": "chatgpt-software-engineering-docs",
  "title": "【ChatGPT】软件工程研发使用的文档",
  "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": "[!note] ChatGPT 问答录 本文保存一次 ChatGPT 问答原始输出，仅作为资料来源；其中结论未自动视为已验证知识，使用前应结合可靠来源复核。",
  "contentRole": "unspecified",
  "isMoc": false,
  "mocRecognition": "none",
  "generated": false,
  "attribution": "unspecified",
  "domain": "99-资料来源、摘录与归档",
  "tags": [],
  "mocs": [],
  "contentHash": "2744c35376a51079c53981d237232386ae53e50ec16f957ac7cce41a37cc879f",
  "assets": [
    {
      "reference": "assets/0023 - 【ChatGPT】软件工程研发使用的文档__resource-002-755e8349fce0.png",
      "url": "/media/1dabd809030c0413100c.png",
      "mediaType": "image/png",
      "contentHash": "1dabd809030c0413100c44938d7c7e0c7ab731ed75a498432956246fbd2286ac",
      "byteLength": 49527,
      "width": 726,
      "height": 468
    },
    {
      "reference": "assets/0023 - 【ChatGPT】软件工程研发使用的文档__resource-001-46a3ae6ec7d0.png",
      "url": "/media/c962cec2407d43888027.png",
      "mediaType": "image/png",
      "contentHash": "c962cec2407d438880276aa1586b93202b48bdece038b8fc6765c8717db5b33e",
      "byteLength": 75633,
      "width": 839,
      "height": 681
    }
  ],
  "headings": [
    {
      "depth": 1,
      "text": "【ChatGPT】软件工程研发使用的文档",
      "anchor": "chatgpt软件工程研发使用的文档",
      "citation": "https://www.pystone.net/notes/chatgpt-software-engineering-docs/#chatgpt%E8%BD%AF%E4%BB%B6%E5%B7%A5%E7%A8%8B%E7%A0%94%E5%8F%91%E4%BD%BF%E7%94%A8%E7%9A%84%E6%96%87%E6%A1%A3"
    }
  ],
  "claims": [],
  "outgoing": [],
  "incoming": [
    {
      "id": "note:sources-excerpts-archive",
      "title": "资料来源、摘录与归档",
      "url": "https://www.pystone.net/notes/sources-excerpts-archive/",
      "atlas": "https://www.pystone.net/?node=sources-excerpts-archive#knowledge-atlas",
      "label": "资料来源、摘录与归档",
      "origin": "explicit",
      "humanReviewed": true,
      "context": "02-AI对话与研究原始输出中的“【ChatGPT】软件工程研发使用的文档”导航项",
      "citation": "https://www.pystone.net/notes/sources-excerpts-archive/#02-ai%E5%AF%B9%E8%AF%9D%E4%B8%8E%E7%A0%94%E7%A9%B6%E5%8E%9F%E5%A7%8B%E8%BE%93%E5%87%BA"
    }
  ],
  "contentMarkdown": "> [!note] ChatGPT 问答录\n> 本文保存一次 ChatGPT 问答原始输出，仅作为资料来源；其中结论未自动视为已验证知识，使用前应结合可靠来源复核。\n\n---\ntitle: \"【ChatGPT】软件工程研发使用的文档\"\ncreated: \"2023-07-14T08:33:30.000004Z\"\nupdated: \"2023-07-14T08:36:30.000004Z\"\nsource: \"yinxiangbiji\"\nsource_notebook: \"3-3 管理-工程与人\"\nsource_url: \"https://chat.openai.com/c/82b45209-a80c-4add-8926-8eab0921397e\"\n---\n# 【ChatGPT】软件工程研发使用的文档\n![](assets/0023 - 【ChatGPT】软件工程研发使用的文档__resource-002-755e8349fce0.png)\n\n\n是的，通常来说，功能设计文档和技术实现文档（包括程序设计）是分开的。\n\n1. 功能设计文档通常是一份面向所有项目参与者的文档，包括产品经理、业务分析师、UI/UX设计师、开发人员等。它描述了系统的业务需求，以及如何满足这些需求的功能性和非功能性需求。这种文档的主要目的是确保所有参与者对系统的需求和目标有共同的理解。\n1. 技术实现文档和程序设计文档更侧重于为开发人员提供技术细节和实现方案。这些文档可以包括系统架构、模块设计、接口设计、数据库设计、算法设计等内容。这些文档的目标是为开发和维护提供清晰的指南。\n分开这两类文档的好处是，非技术人员（比如产品经理或业务分析师）可以更好地理解功能设计文档，而无需深入理解技术细节。同时，开发人员可以参考技术实现文档来实现和维护系统，而无需深入理解业务逻辑。当然，这并不意味着开发人员不需要理解业务，但是在设计和实现阶段，他们的主要关注点是如何实现需求，而不是需求是什么。\n\n\n![](assets/0023 - 【ChatGPT】软件工程研发使用的文档__resource-001-46a3ae6ec7d0.png)\n\n\n以下是一个基于你所提原则的最小必要文档类型，它们可以在大部分的软件开发项目中应用：\n\n1. 需求文档：这个文档应该描述产品应该做什么，以及为什么做这些功能。它应该包括用户故事、用例、或者其他的描述方式。重点是清晰地描述业务需求，用于让整个团队（包括非技术人员）理解产品的目标和用户期待的功能。\n1. 功能设计文档：这份文档将需求文档中的需求进行详细展开，以澄清产品的特性、行为和工作方式。这份文档应该能够帮助设计师、开发人员、测试人员等理解系统的功能性需求。\n2. 技术架构文档：这份文档描述了系统的整体技术设计，包括选择的技术栈、系统模块、数据流、接口等。它提供了开发团队需要的技术指导，以便他们理解和实现系统。\n3. 接口和数据库设计文档：如果产品有API接口或者数据库相关的设计，那么这些接口和数据库的设计也需要进行详细的描述。这可以帮助开发人员理解系统的数据流动方式以及如何使用API接口。\n4. 测试文档：这份文档描述了产品的测试策略、测试计划、测试用例等信息。它可以帮助测试人员理解他们需要做的测试工作，并指导他们进行测试。\n5. 部署和运维文档：对于任何需要部署的软件，都需要有详细的部署文档和运维文档。这些文档通常包括环境配置、部署步骤、监控和日志等信息。\n这些类型的文档都对项目的开发、测试、部署和运维有所帮助，也便于在团队间进行沟通。当然，这只是一个基本的列表，具体的文档可能根据项目的具体需求和团队的工作方式进行调整。\n"
}