学习
实践
活动
专区
工具
TVP
写文章

怎么写设计文档

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

38930
  • 广告
    关闭

    9块9,云智绘帮您轻松搞定营销设计!

    10万模板,1亿优质图库,正版商用授权,涵盖电商、banner海报、新媒体配图、教育培训海报、H5等各种场景

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

    Grafana Loki 设计文档

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

    1.4K10

    腾讯文档 | 数据化设计

    百度指数-需求图谱-word模板 以“腾讯文档为”项目为例,我们想提高腾讯文档用户创建文档的成功率,通过模板创建文档是关键路径之一。研究用户通过模板创建的路径时,想大概了解用户找模板时可能会在意什么。 以腾讯文档为例,在线文档的核心用户价值是“从创作到协作的多人多端无缝同步”,因此我们定义用户的关键路径是“创作→分享→协作”,即: ? 建立用于监控“转化质量”的行为漏斗 我们发现仅30%的创建人在分享文档前设置了非私密权限——这个数据并不符合我们的预期,因为这会导致创建人分享文档后,协作人无法直接查看或编辑文档设计师需要观察综合的数据指标,以腾讯文档为例常规的指标有:PV、UV、人均点击次数、功能渗透率、使用该功能的留存率等等。 另外是多渠道收集用户反馈,包括腾讯文档的“吐个槽”社区、微博搜索关键词、随访身边的用户朋友等。 Conclusion 结语 数据化设计不是对“精心打磨体验”的否定。

    1.1K20

    开发规范四:设计文档

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

    18850

    文档处理与查询设计

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

    7250

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

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

    75420

    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、“消息”是在两台计算机间传送的数据单位

    66180

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

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

    50050

    API 库的文档体系支持:主流编程语言的文档设计

    这里所指的编程语言的文档体系,主要是指语言标准库中的文档。 新一代编程语言的文档体系 作为一个程序员,和诸多人一样,我并不热衷于在代码中写文档/注释。 从文档代码一致性上来看,从我初步阅读代码的情况来看,Rust、Julia 的文档工具都会校验文档中的代码是不是正常的,并能对其进行测试。 后续,可能会在文档体验设计相关的文章中,进行详细的介绍。 Rust 的文档测试示例 说了那么多,让我们先简单看个示例。 基于 markdown 这一点倒是没有啥说的,markdown 在今天已经成为了事实上的开发文档标准。 1. 为扩展设计文档 DSL 从做法上可以分为: 让语法块可运行。 为准确性设计文档测试 为了确保文档与代码保持一致,又或者是文档中代码的准确性,我们需要引入文档测试的方式来检查 API。

    16520

    dotnet 文档应用的撤销重做设计

    文档应用是指如 Word 或 PPT 等的提供给用户进行内容创作的工具,而撤销重做其实也被称为撤销恢复功能。 本文来告诉大家撤销重做这个模块的设计路线,从简单的复杂 大部分的应用软件都可以采用敏捷开发,不断进行迭代。应用的每个小功能都在不断迭代中,成为模块或者某个团队产品。 ,但按照本文的编写方法,如果一开始就来开设计类,我预计将会十分无聊 在定义好了 撤销重做栈 之后,咱将会遇到一个问题,那就是这个 撤销重做栈 的代码应该如何写? 如果有这样的需求,那么对于 IOperation 的设计上,就需要开发者设置为基于数据,不能基于对象的动作 另外,即使没有漫游同步的功能,其实文档保存也可以复用撤销重做提供的功能。 在文档保存的时候,很多文档软件都有自动保存的功能,如 VS 软件。在文档内容很多,保存一次需要大量的时候时,就需要用到增量的功能,那么如何实现增量?

    34640

    腾讯文档周年品牌视频设计方法

    一、概述 Overview 关于腾讯文档 | About Tencent Docs 腾讯文档自2018年4月上线以来,为众多用户提供服务,已积累超过30亿份文档。 到目前为止,腾讯文档一直是众多用户高效工作和沟通的得力助手。今年是腾讯文档成立4周年,为了更好地展望未来发展,腾讯文档制作了一个全新的品牌视频。 整个视频的基调和方式是基于腾讯文档的身份系统来表达的。 欢迎扫码加入一起聊设计 (入群暗号:ISUX) 以下ISUX文章,你可能也感兴趣 ▽ 设计效率工具趋势 | 综述篇 2021-2022 设计趋势ISUX报告·数字未来篇 QQ-Studios Showreel 揭秘 | 虎年PUPU设计密码 ---- 凝集腾讯设计优质内容 更多精彩分享请关注  ▼

    11840

    关注

    腾讯云开发者公众号
    10元无门槛代金券
    洞察腾讯核心技术
    剖析业界实践案例
    腾讯云开发者公众号二维码

    相关产品

    • 设计协作平台

      设计协作平台

      腾讯自研的产品设计研发一站式协作平台,支持在线导入预览Sketch设计稿、自动生成设计标注切图,灵活调用图标库、素材库,支持多种插件上传,让产品设计更轻松高效。

    相关资讯

    热门标签

    活动推荐

    扫码关注腾讯云开发者

    领取腾讯云代金券