平平淡淡从从容容

0%

技术文档

发表于 分类于 3.3k 3 分钟

朝闻道，夕死可矣。 ————《论语·里仁》

技术文档

一、技术文档

  1. 项目文档：用于开启新项目的整体概要文档，说明项目背景、成员、依赖关系、项目整体排期、里程碑、 模块概述、系统交互、
  2. 部署文档：介绍网站或系统如何进行部署，搭建运行环境，通常需要说明代码的Git仓库位置、数据库结构、Nginx/Apache配置、计划任务配置、其他配置，是否需要CDN或HTTPS等，以及注意事项。
  3. 接口文档：针对每个API接口提供的文档，说明接口地址，调用方式，接口参数，返回结构，异常情况等。
  4. 模板文档：提供给前端使用的模板文档，说明每个网站页面会存在哪些变量、类型是什么、以及处理逻辑，方便前端进行渲染、展示和交互。
  5. 设计文档：针对系统、子系统或某个功能模块的设计说明，从技术架构到软件设计，到数据库建模，以及核心技术的介绍，性能分析等，面向对象是相同专业的专业人员。
  6. 开发文档：针对每个开发需求而编写的文档，说明需求的背景、当前需求的实现思路，并记录这个需求所产生的接口文档、模板文档、数据库变更、上线待办清单、代码仓库和相应的开发分支，以及一些注意事项，方便需求在开发过程中，以及在测试联调过程中，有很好的文档进行备忘、沟通和回顾。如果有依赖底层或第三方的接口，也应一并补充。若有外部调用方，也应进行登记。
  7. 故障文档：当出现线上故障时，处理完毕后，应编写故障复盘文档，进行原因分析、思考改进措施、贴出关键的代码、交待故障发生以及处理的历史过程，方便团队进行回顾、学习和避免类似问题再次发生。
  8. 分享文档：对新技术或已有技术的技术分享，例如：如何利用docker部署本地开发环境。
  9. 新人文档：为新加入团队成员而编写的新人指引教程，包括系统介绍、应该开通哪些账号、遇到的一些常见问题、入周第一周应该做什么、开发环境(包括扩展)、通用代码、服务器环境、关键代码描述
  10. 系统负责人文档：日常紧急任务或假期期间
  11. 数据库文档：数据库创建规范、使用规范、系统数据库字典等
  12. 版本文档：系统发布版本记录
  13. 需求文档：产品PRD文档
  14. 代码规范：代码评审标准、评审记录、优秀代码案例等

二、如何书写

TODO

三、参考

  1. https://www.zhihu.com/question/29786741
  2. https://zhuanlan.zhihu.com/p/137279920
  3. https://www.zhihu.com/question/427404344/answer/1709304008

开发文档

一、基础

      开发文档，是针对每个开发需求而编写的文档，用来说明需求的背景、需求的实现思路，并记录这个需求所产生的接口文档、模板文档、数据库变更、上线待办清单、开发分支、注意事项等，方便在开发、联调、测试、上线过程中有很好的文档支撑，提高协同效率，提升系统稳定性。如果需求有依赖底层或第三方的接口，或者有外部调用我方，也应一并记录方便查阅。

二、如何

  1. 背景
  • 开发人员
  • 业务背景
  • 技术背景
  1. 需求分析
  • 业务痛点
  • 性能需求
  1. 方案描述
  • 方案一
  • 方案二
  1. 线上方案
  • 异常边界
  • 统计与监控
  • 灰度&回滚
  • 关键点&设计述求
  1. 部署扩展
  2. 风险评估

调研报告

一、基础

      技术调研报告是对某一特定领域的技术趋势、发展方向、最新技术、应用场景等内容进行系统研究和分析的报告。

书写建议

  1. 使用简明的语言：避免使用过于专业的术语，尽可能使用简单易懂的语言来解释技术问题，同时使用图表和图片帮助理解。
  2. 解释技术背景和目标：在报告的开头部分，解释技术调研的背景和目标，以帮助读者了解你的研究为什么重要以及要解决什么问题。
  3. 描述技术架构和功能：提供清晰简洁的技术架构图，用简单的语言描述每个组件的功能和相互关系。避免使用复杂的技术术语，而是尝试用更直观的方式解释。
  4. 说明技术优势和不足：在技术调研报告中，不仅要说明新技术的优势，也要讨论其不足之处。这样可以帮助读者更全面地了解新技术，从而更好地做出决策。
  5. 给出建议和结论：最后，在报告的结尾部分，给出基于调研的建议和结论。建议可以包括如何在实际应用中使用该技术，结论可以概括技术调研的重点和结论。尽可能使用简洁明了的语言，帮助读者快速了解你的结论。

总之，技术调研报告需要将技术问题用简单易懂的语言解释清楚，同时要提供清晰简洁的图表和图片，以便非专业人员理解和理解。

二、步骤

以下是编写技术调研报告的一些基本步骤：

  1. 研究目标：明确研究目的和需求，对所要研究的技术领域进行准确定义。
  2. 数据收集：收集和整理所需要的信息和数据，包括文献资料、市场调查、用户需求等方面的信息。
  3. 分析和总结：对收集到的信息和数据进行整理、筛选、分析和总结，形成初步的结论和建议。
  4. 报告撰写：根据研究目标、数据收集和分析结果，撰写技术调研报告。报告应包括以下主要内容：
  5. 技术概述：对研究的技术领域进行概述，包括相关技术、发展历程、应用场景等内容。
  6. 技术趋势：分析当前技术发展的趋势，预测未来发展方向。
  7. 竞争分析：对相关竞争对手的技术情况进行分析，包括技术优势和不足、市场份额等内容。
  8. 应用案例：列举一些成功的应用案例，分析其成功原因和可借鉴之处。
  9. 建议和结论：根据研究结果，提出对该技术领域的建议和结论，包括未来发展趋势、创新方向等内容。
  10. 报告评审：对编写好的报告进行内部评审，确保报告内容准确、清晰、有条理，并符合组织的格式和要求。
  11. 报告发布：将编写好的报告进行最终修改和修订后，发布到指定的人员或机构，以供参考和使用。

ChatGPT调研报告

一、技术概述

      ChatGPT是由OpenAI团队开发的一个基于自然语言处理的可实现对话、翻译、图像处理、代码生成等的机器人模型的统称，它包括Fine-tuning models、Codex、DALL~E、Whisper、Embedding、Moderation等多个系列，每个系列又分为Turbo、Davinci、Curie、Babbage、Ada等多个模型。它采用GPT(Generative Pre-trained Transformer)模型和自然语言处理技术，通过在大规模数据集上进行无监督学习来训练，能够生成连贯、自然的语言输出，具有较强的智能交互能力。

二、发展历程

  1. 人工智能发展形成阶段
  2. 人工智能快速成长阶段
  3. 机器学习和神经网络
  4. Transformer

三、竞争分析

  1. 谷歌：Dialogflow，官网
  2. 微软：Azure Bot Service，官网
  3. 脸书：wit.ai，官网
  4. 百度：Duer，官网

四、应用案例

  1. 客户服务：作为智能客服人员，为用户提供24小时在线服务，解答用户的问题和疑问。
  2. 社交娱乐：作为聊天机器人，为用户提供个性化的娱乐互动，增加用户粘性和活跃度。
  3. 教育培训：作为智能导师，为学生提供个性化的学习辅导和指导，提高教学质量和效率。

五、优缺点

六、结论

七、参考

  1. https://openai.com/pricing
  2. https://platform.openai.com/tokenizer
  3. https://platform.openai.com/playground
  4. https://status.openai.com/
  5. https://github.com/orhanerday/ChatGPT
  6. https://platform.openai.com/docs/models/overview
  7. https://help.openai.com/en/
  8. https://community.openai.com/
  9. https://help.openai.com/en/collections/3675931-openai-api
  10. https://help.openai.com/en/articles/6950777-chatgpt-plus
  11. https://help.openai.com/en/articles/6891839-api-error-code-guidance
  12. https://help.openai.com/en/articles/6950777-chatgpt-plus