首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

怎么写设计文档

4 详细设计 5 操作流程 ---- 一份好的设计文档需要提供清晰的问题描述、整体的概要设计、涵盖各个细节的详细设计等。...这篇有趣的英文小短文通过一个简单的小例子介绍了Google工程师是怎么写设计文档的。本文为中文翻译。...在我工作过的其他公司中,没有一家对如何使用文档进行协作有这样深刻的理解。 这篇文章就是关于我在谷歌如何写设计文档的一个例子,这是一个真实的项目,用于在新冠疫情期间控制健身房现场人数。...为了让这篇文章更有趣,现在每个人都可以在谷歌文档[2]上进行评论,而且谷歌文档的格式也比Medium支持的要好。...但这显然超出了设计文档的范围,而且是非常主观的想法。

1.8K30
您找到你想要的搜索结果了吗?
是的
没有找到

Grafana Loki 设计文档

本文的目的是为了解释 Grafana Loki 服务的设计动机。本文档并不会深入描述设计的所有细节,但希望能够对一些关键点进行说明,使我们能够提前发现任何明显的错误。...注意本文只是 Loki 的最原始设计文档,现在很多功能都已经实现和架构也有变化,请不要当成最新的 Loki 实现文档。...要了解最新版本请查看官方文档: https://github.com/grafana/loki/tree/master/docs 背景和动机 事件响应和上下文切换 Metrics 指标数据是事件响应的关键...所以,该设计的第一个目的是将日志和指标之间的上下文切换成本降到最低,这样有助于减少事件响应的时间并改善用户体验。...这两个设计策略可以大幅降低成本并简化操作,但是我们认为这并不能满足我们的其他设计要求 - 查询表达能力不足。但是,我们确实也认为这是一种比较好的本地解决方案。

2.4K10

开发规范四:设计文档

发布版本-需求标题 文档变更记录 日期 版本号 修订内容 修订人 目 录 [TOC] XXX功能详细设计 【 详细设计文档针对一个具体功能或者模块进行详细设计, 完成设计文档后...不能直接删除章节,若不进行设计,请写“无”。 注意修改页文档版本控制。...】 功能设计 设计思路 【 描述本需求实现的详细设计思路 】 接口设计 接口设计原则 https://cloud.google.com/apis/design 接口清单 【 接口名称 Protocol...buffer源码 】 数据库设计 设计思路 【 比如表的设计思路、数据拆分思路等。...】 数据库设计内容 【 创建表或者新增、修改字段的sql。 】 冗余设计 【写出哪个库、表、字段需要冗余,冗余数据如何同步。

1.3K50

腾讯文档 | 数据化设计

百度指数-PPT模板的搜索指数最高 百度指数-需求图谱-word模板 以“腾讯文档为”项目为例,我们想提高腾讯文档用户创建文档的成功率,通过模板创建文档是关键路径之一。...,协作人无法直接查看或编辑文档。...这里举一个“小需求”为例:腾讯文档Excel的PC端右键菜单高度优化。笔者目前负责腾讯文档编辑模块的UX工作,日常就是很多这样的“小优化”,其实这更加考验数据敏感度和对“严谨”的坚持。...设计师需要观察综合的数据指标,以腾讯文档为例常规的指标有:PV、UV、人均点击次数、功能渗透率、使用该功能的留存率等等。...另外是多渠道收集用户反馈,包括腾讯文档的“吐个槽”社区、微博搜索关键词、随访身边的用户朋友等。 Conclusion 结语 数据化设计不是对“精心打磨体验”的否定。

1.5K20

机票预订系统设计文档

二、系统架构设计机票预订系统的架构分为前端和后端两部分,前端主要负责用户界面的展示和交互,后端则负责数据的处理和存储。1.前端架构前端架构采用了MVC架构,即模型-视图-控制器架构。...三、系统功能设计机票预订系统的主要功能包括:1.机票查询功能用户可以根据出发地、目的地、出发时间等条件查询符合要求的机票信息。2.机票预订功能用户可以选择符合条件的机票,并进行预订。...四、系统数据库设计系统数据库包括以下表格:1.用户表用户表存储用户的基本信息,包括用户名、密码、邮箱等。2.机票表机票表存储机票的基本信息,包括出发地、目的地、出发时间、到达时间等。...七、系统测试设计为了保证系统的质量,需要进行以下测试:1.功能测试对系统的各项功能进行测试,以保证系统的功能正常。2.性能测试对系统的吞吐量、响应时间等进行测试,以保证系统的性能满足要求。...在设计机票预订系统时,需要考虑系统的架构、功能、数据库、安全和性能等方面,以保证系统的质量和稳定性。

84200

文档处理与查询设计

一、请给出上述文档集合进行分词和去除停用词之后的结果。 1.1 分词 实现思路 针对文档文档进行分词,利用python中的jieba库可以很轻松的实现。...根据上述内容,设计实现就比较简单了,同样先整理一份去重词表,再逐句匹配,存在就添加索引,这里的索引直接用给定文档的Key作为唯一ID。...TF-IDF算法 词频(TF)=某个词在文档中出现的次数/文档的总词数 逆文档频率(IDF)=log(语料库的文档总数/(包含该词的文档数+1)) TF−IDF=词频(TF)×逆文档频率(IDF...框架图 功能说明 文档预处理(语言及其他处理) 包括文档格式处理、文档语言识别、文档编码识别,即在文本分类索引之前,先对文档进行预处理。...文档评分 即对查询-文档匹配评分计算,通过评分方法得出文档集中相关度从高到低的排名,包括Jaccard系数等。

66550

架构设计文档模板

一.简介 架构设计中最重要的两个文档的模板和关键说明。这个案例文档仅给出一些关键内容供你参考,部分细节无法全面覆盖或者完全保证正确。...如果是复杂的业务系统,这部分也可以独立成“用例文档”] 消息队列有两大核心功能: 业务子系统发送消息给消息队列。 业务子系统从消息队列获取消息。...2.3 复杂度分析 [分析需求的复杂度,复杂度常见的有高可用、高性能、可扩展等,具体分析方法] 子主题注:文档的内容省略了分析过程,实际操作的时候每个约束和限制都要有详细的逻辑推导,避免完全拍脑袋式决策...三.架构设计模板 [备选方案评估后会选择一个方案落地实施,架构设计文档就是用来详细描述细化方案的] 3.1 总体方案 [总体方案需要从整体上描述方案的结构,其核心内容就是架构图,以及针对架构图的描述,包括模块或者子系统的职责描述...3.4.2 高性能设计 3.4.3 可扩展设计 3.4.4 安全设计 消息队列系统需要提供权限控制功能,权限控制包括两部分:身份识别和队列权限控制。

49710

腾讯文档 | 全平台系统设计

腾讯文档面临的挑战 腾讯文档发布于 2018 年,支持主流的平台和系统。但随着功能的扩展,设计和开发维护成本也在多线程同步增加,而且因为开发的时间差,很容易出现体验不一致,功能对不齐的情况。...全平台设计的原则 此时此刻,一个腾讯文档的白领用户可能正在工位写报告或通勤的路上查阅文档,一名学生可能在电脑上写论文或者去打印店打印,一位老师则可能刚刚发了一份在线统计表格到群里让各位家长在手机上填写。...腾讯文档需要尽可能多地覆盖渠道和场景,支撑用户真正做到随时随地打开文档,快速完成当下的任务。 但值得注意的是,在全平台的设计当中我们并不追求完全的一致,而是整体感知的和谐。...那么腾讯文档如何保持其“效率”的特征?为此我们确立了以下设计原则:确保内部感知的一致性,让各端效益最大化。...欢迎各大设计师加入和我们一起聊设计~ 添加QQ群:764345161 或长按以下二维码 以下ISUX文章,你可能也感兴趣 ▽ QQ自习室 | 年轻人学习方式的设计探索 腾讯文档品牌升级 (上) “哥是鹅

2.3K20

Msmq设计文档(赋源代码)

Msmq设计文档 文件状态: [√] 草稿 [  ] 正式发布 [  ] 正在修改 文件标识: ECI-MSMQ v01 当前版本: 0.5 作    者: 阿新 完成日期: 2005-8-18 1.0...文档说明: 1.1文档目的 介绍了MSMQ的基本编程(如存储和接收消息)和基本的管理功能(如创建和删除队列)。...因此,在设计新的分布式应用程序时,建议遵守面向服务架构(Service-Oriented Architecture)的基本思想:通过显式定义边界、创建自治服务,让MSMQ来负责交互部分。...1.2文档范围 涉及居于MSMQ基础的传输信息的交互开发 1.3读者对象 系统设计人员,开发人员,测试人员 1.4参考文献 Msdn Cnblogs 1.5专业术语 1、“消息”是在两台计算机间传送的数据单位

1.2K80

只是写设计文档设计, 就是瞎折腾

2017.3.26, 深圳, Ken Fang 做产品, 需要的是 “产品软件设计”, 而不是 “设计文档”。...只要是产品开发当然要做产品软件设计。 但产品软件设计到底要达到什么的目的? 许多人都不去思考这最根本的问题, 反而是, 只是纠结有没有设计文档。...结果是,即使是有了设计文档,原来没有设计文档时, 所产生的问题,不仅是还没有解决,还瞎折腾了一堆文档。这就是咱们做事,最没效率,也最无知的地方。 产品软件设计最主要要能达到的目的: 1....所以, 不要只是拿个设计模板就去写,就说是在做产品软件设计;这样只是在写作文, 不是在做产品软件设计。...当产品开发达到某个基准线时, 再将版本中的关键信息, 整理成产品的知识 (文档) 。唯有如此, 才能保证产品的知识 (文档), 是与产品的现况是匹配的。

68950
领券