- 综合排序
- 最热优先
- 最新优先
- 来自专栏机械之心
技术文档规范
# 技术文档规范 文档采用 Markdown 语法书写。 一个句子建议不超过 100 字或者正文的 3 行。 尽量使用简单句和并列句，避免使用复合句。 # 2.3. 写作风格 尽量不使用被动语态，改为使用主动语态。 # 3. 段落 # 3.1. 段落原则 一个段落只能有一个主题，或一个中心句子。 段落的中心句子放在段首，对全段内容进行概述。后面陈述的句子为核心句服务。 目录结构 技术手册目录结构是一部完整的书，建议采用下面的结构。 文件名 文档的文件名不得含有空格。 文件名必须使用半角字符，不得使用全角字符。这也意味着，中文不能用于文件名。
1.6K40编辑于 2023-04-07 - 来自专栏后端码事
Kafka 技术文档
Kafka 技术文档 Kafka创建背景 Kafka是一个消息系统，原本开发自LinkedIn，用作LinkedIn的活动流（Activity Stream）和运营数据处理管道（Pipeline）的基础 2) 加入group中,有如下consumer: C0,C1 3) 首先根据partition索引号对partitions排序: P0,P1,P2,P3 4) 根据consumer.id排序: C0 结果发现属于group1的consumer收到了所有的这三条消息，同时group2中的3个consumer分别收到了key为1，2，3的消息。如下图所示。 ? localhost:2181 --from-beginning --topic my-replicated-topic --my test message 1 --my test message 2 各项技术 大多数消息系统声称可以做到“精确的一次”，但是仔细阅读它们的的文档可以看到里面存在误导，比如没有说明当consumer或producer失败时怎么样，或者当有多个consumer并行时怎么样，或写入硬盘的数据丢失时又会怎么样
98110发布于 2020-09-11 - 来自专栏后端码事
RabbitMq 技术文档
abbitMq 技术文档 AMQP简介 AMQP即Advanced Message Queuing Protocol，高级消息队列协议，是面向消息中间件设计的应用层协议的一个开放标准。 AMQP简介... 3 2. AMQP的实现... 3 3. 3) 接收端：Recv.java 不断等待服务器推送消息，然后在控制台输出。 下面我们先运行3个工作者（Work.java）实例，然后运行NewTask.java，3个工作者实例都会得到信息。但是如何分配呢？ 架构图如下： 设计架构可以如下：在一个集群里，有3台机器，其中1台使用磁盘模式，另2台使用内存模式。
3K11发布于 2020-09-11 - 来自专栏杨建荣的学习笔记
关于技术文档
关于写技术文档，我觉得是很多做技术的同学头疼的，因为写起来确实有很多注意的细节，很花时间和精力，而反过来说，做技术的同学更头疼的是，工作中竟然没有文档说明，没有了文档那么就是个人主义了，所以文档的事情对很多人来说是一种比较纠结的情况 操作型文档，里面会有很多的技术细节 流程型文档，这种文档的主要是做一些铺垫和补充，比如有些内容简介，制度规约之类的。 而工作中，你的工作成果和技术积累，其实就是通过文档的积累整理出来的。我举三个例子。 首先第一个是文档库的事情。 文档库是很多公司都在使用的技术手段，如果我们要重新设计一个文档库，就会把他规划的很细很全，但是实际去写文档的时候，会发现事情比预想的要难一些，因为从业务和技术两个维度，技术上都可以实现，但是具体去操作的时候就有很大的差别 所以我们准备对已有的技术分享做一层沉淀，通过一些内容上的调整和梳理行程一个较为系统的文档，如果新员工来了之后，就会少走一些弯路。这个时候这个文档的重要性就体现出来了。 第三个是工作成果文档的事情。
921101发布于 2018-04-17 - 来自专栏icecream小屋
gensim技术文档
1，文本的数据清洗： 过滤文章中包含无用词的语句 去除文章中特定词性的词 提取全部文本 将空文本去除 2.生成词典并向量转化 3.主题向量的转化 1）首先将模型对象的始化。 （2）利用初始化的模型将语料转化为对象的向量 1）TFIDF（词频逆文档频率） 2）LSI（潜在语义索引） 将词袋模型或TFIDF空间映射到低维度的潜在空间，推荐200-500为金标准，在达观数据的长文本分类中 LSI可以进行增量训练，只要有新文档可以一直输入模型当中，通过add_document方法。如果python报memoryerror，那就是内存不够了，需要降低维度。 3)LDA（隐含狄利克雷分配） LDA是LSA的概率扩展，也是向低纬度转化的方式 4)RP(随即映射) 目的在于减小空维度，通过随机性，近似的到文档之间的TFIDF距离，但对于大数据量很慢 4.相似度匹配 在得到文章对应的主题向量以后，就可以进行相似性匹配，将多个文档遍历进行匹配，然后排序选择相似度最大的文章，取其在训练集中对应的分类编号，作为测试文档的类别。
1.1K20发布于 2019-12-26 【技术文档：技术传播的灯塔】
在技术的浩瀚海洋中，一份优秀的技术文档宛如精准的航海图，指引着航行者穿越波涛汹涌的未知领域。它是知识传承的载体，是团队协作的桥梁，更是产品成功的幕后英雄。然而，打造这样一份出色的技术文档并非易事。 一、技术文档的重要性技术文档是产品开发和维护过程中不可或缺的一部分。它不仅为开发者提供了详细的技术参考，也为新成员的快速上手提供了便利。一个清晰、准确的技术文档可以减少误解和错误，提高团队的工作效率。 适时更新：技术是不断发展的，技术文档也需要定期更新，以反映最新的技术变化和产品更新。 四、创新方法在技术文档的编写过程中，也可以采用一些创新的方法来提高文档的质量和可读性：交互式文档：利用现代技术，如 HTML5 和 JavaScript，创建交互式的技术文档，提供动态的示例和模拟。 社区参与：鼓励用户和开发者参与文档的编写和改进，通过社区的力量来丰富和完善文档内容。图片五、结语技术文档是技术传播的灯塔，它不仅照亮了技术实施的道路，也连接了知识的传承和团队的协作。
37800编辑于 2024-11-28- 来自专栏GopherCoder
技术文档如何编写？
关于文档编写的几个思维 近期重新组织了好几篇技术文档，把其中的一些感悟提炼出来。 按照现有文档完成后的文档输出如何组织？ 0. 程序员如何看待文档？ 程序员一定会是接触各种各样的技术文档，文档写的好与不好，大致都能区分出来。 但是对于自己写的文档却可以容忍 “丑陋” 、“难以理解”等...... 对技术、代码可以修改、修改、再修改，优化、优化、再优化...... pic_2.png 这里有一篇中文技术文档写作规范参考：阮一峰：中文技术文档写作规范 标题： 我只谈论一点：标题原则上存在六级，即一级、二级、三级、四级、五级和六级标题。 综上：编写文档的两个思维是： 流程化：1. 先有什么 2. 后有什么 3. 最后结果 精细化：逻辑表达、内容组织、排版 ? pic_3.png
8.1K61发布于 2018-06-06 - 来自专栏北京马哥教育
如何阅读技术文档
答：“去看文档” “Django的文档都是英文，我看不下去，怎么办” 答：“bla bla bla…. 关于英文的重要性” “Django的文档那么多，我是不是都得看完才行？” Django框架，当时同事给我推荐过一本Django的英文书《Practical Django Projects》,当时看了几页，因为速度太慢，就转向这个网站：http://djangobook.py3k.cn 再之后，每每遇到问题请教同事或者在网上查得时候总能得到这样的反馈——你看过这部分的文档吗？！先去看看文档再来讨论。 于是乎，在这样不断的被鄙视过程中不断的熟悉了Django的官方文档，对于Django的问题也终于有了正确的认识——那就是，有问题就去看文档;出错了，一定是你文档看的不仔细。 除了在这样被鄙视的的状态下去看文档的，自己也尝试过去挨篇读文档，唯一的收获就是大概知道有哪些东西了，附带的收获就是对文档这东西不那么陌生了。
2.4K90发布于 2018-05-03 TwinCAT 3 塑料加工框架 - PLC 温度控制器技术文档
一、文档概述 1.1 文档目的 本文档基于 TF8540 版本 1.1.0，详细拆解 TwinCAT 3 塑料加工框架中 PLC 温度控制器的核心功能、技术参数、操作流程及故障处理，为技术人员提供系统化的学习参考 1.2 适用范围 适用人员：具备控制与自动化技术基础、熟悉相关国家标准的专业技术人员。 适用场景：塑料加工设备的 PLC 项目搭建、温度控制器调试、参数优化、故障排查。 3.1.2 FB_TempCtrlMainBody_TcPfw_TC3() 扩展功能：在基础版之上增加参数加载校验接口和温度区变量显示功能。 七、关键操作注意事项 人员资质：仅允许受过专业培训的技术人员操作，严格遵守安全规范。 硬件兼容：确保 I/O 终端类型与配置的 TempSensTerm 一致，避免通信故障。
12710编辑于 2026-03-19- 来自专栏Android开发指南
3.接口文档
接口文档 HTTP部分 全局规范 Login 登录接口 Register 注册接口 搜素用户接口 接受用户用户邀请 获取朋友列表 修改用户名接口 Socket自定义协议 全局规范 client 请求部分 icon": "/a/b/zhangsan.png", "sign": "我的个性签名", "area": "深圳", "token": "5904c7ae-3e75 , "type": "response", "flag": "true", } 失败 : { "sequence": "3", "type": "response" , "type": "response", "flag": "true", } 失败 : { "sequence": "3", "type": "response" , "type": "response", "flag": "true", } 失败 : { "sequence": "3", "type": "response"
1.2K50发布于 2018-05-14 - 来自专栏混说Linux
搞技术，如何写好技术文档？
很多技术人自己非常轻视技术文档的书写，然而又时常抱怨文档不完善、质量差、更新不及时… 01 文档的重要性 高质量的文档对于一个组织或团队来说有非常多的益处，比如让代码和API更容易理解、错误更少； 关于文档的重要性，每个技术人或多或少都知道一些，但很多人还是没有写文档的习惯，为什么？ 3.清晰的分类 文档大致可以分为以下几种类型，每种类型也有自己不同的特点和写作侧重点。 落地页的技术难度不高，但要求内容的有效性、完整性和分类清晰。 4.文档Review 在一个组织内，光靠个人去维护文档是不行的，必须得借助群体的智慧。 技术文档也算是文章的一种，所以一般也都会有这三部分，每个部分有其自己的作用，比如第一部分阐述问题，中间部分介绍具体的解决方案，第三部分总结要点。
77030编辑于 2022-11-18 - 来自专栏史上最简单的Spring Cloud教程
docker官方文档翻译3
article/details/80171723 本文出自方志朋的博客 个人博客纯净版：https://www.fangzhipeng.com/docker/2018/09/11/docker-trans3. 介绍 第3部分，我们扩展了我们的应用并实现了负载均衡。 要做到这一点，我们必须在分布式应用程序的层次结构中升级一级：服务。 version: "3" services: web: # replace username/repo:tag with your name and image details image
61910编辑于 2022-05-07 - 来自专栏编程心路
Github学习文档-3
3 Git和GitHub相吻 ---- 首先开始打开我们的 Gitbash 命令行窗口，origin 代表我们的本地仓库，origin 后面的 https 地址就是我们刚才从 GitHub 网站复制来的 想熟练使用 Git，就是要多用 Git，出现问题是正常的，本文档中的命令都是基本常用的命令，不可能解决使用Git时出现的错误的，有问题可以在网上查查。下面我们在学习常用几个命令吧。
71220发布于 2018-08-30 - 来自专栏pandacode_cn
技术文档应该如何编写
# 衡量技术文档好坏的标准是什么 Martin(Bob大叔)曾在《代码整洁之道》一书打趣地说：当你的代码在做 Code Review 时，审查者要是愤怒地吼道： “What the fuck is this 根据所编写的文档，判断主要面向的受众是产品、技术、测试还是商务人员，尽量使用他们所能理解和熟悉的词汇和表达方式来表达。 提供必要的信息。 根据需要编写的技术类型，提供必要的信息，就像摄影拍照一样，有一些约定的摄影构图，例如：均衡式构图、对称式构图、对角线构图、三角形构图、九宫格构图等。 很多技术人员觉得编写文档比写代码还要难，还要头疼。其实写文档和写代码是类似的，很难一开始就写出完美的文档。应该是像写代码一样，一开始写得很丑陋，但没关系，至少有内容了。 # 参考资料 如何写好技术文档? (opens new window) 程序员如何编写高大上且实用的技术文档 (opens new window)
91820编辑于 2021-12-17 - 来自专栏DT乱“码”
Java agent技术原理文档
Java agent技术原理文档 Java代理 (agent) 是在你的main方法前的一个拦截器 (interceptor)，也就是在main方法执行之前，先执行agent代码。
1.5K80发布于 2018-02-09 - 来自专栏IT云清
3.Elasticsearch面向文档
1.面向文档 在应用程序中对象很少只是一个简单的键和值的列表。通常，它们拥有更复杂的数据结构，可能包括日期、地理信息、其他对象或者数组等。 也许有一天你想把这些对象存储在数据库中。 Elasticsearch 是 面向文档 的，意味着它存储整个对象或 文档。Elasticsearch 不仅存储文档，而且 索引 每个文档的内容使之可以被检索。 在 Elasticsearch 中，你 对文档进行索引、检索、排序和过滤–而不是对行列数据。这是一种完全不同的思考数据的方式，也是 Elasticsearch 能支持复杂全文检索的原因。 2.Json Elasticsearch 使用 JavaScript Object Notation 或者 JSON 作为文档的序列化格式。 下一篇：4.Elasticsearch索引文档
73820发布于 2019-01-22 - 来自专栏hotqin888的专栏
ONLYOFFICE文档转换开发技术
onlyoffice具有文档转换的功能，就是你给一个文档的地址，以及一些参数，post给document server，它会转换成你要的，然后返回一个文件地址，你收到这个地址，把文件下载下来保存，提供用户下载 测试代码如下： //文档格式转换 type Conversionsend struct { Async bool `json:"async"` Filetype string `json
2.6K20发布于 2019-08-14 - 来自专栏LINUX阅码场
如何写好技术文档？
在整个职业生涯中，每个软件工程师都抱怨过文档的质量、数量或者完全缺乏文档。 01 为什么需要写文档？ 高质量文档对工程组织有巨大的好处。代码和api变得更容易理解。 软件工程师经常需要编写几种主要类型的文档： 参考文档，包括注释 设计文档； 教程； 概念性文档； 1.参考文档 参考文档是工程师最常编写的文档类型;事实上，他们经常需要每天写一些参考文档。 3.教程 每个软件工程师，当他们加入一个新的团队时，都会想要尽可能快地跟上进度。拥有一个引导人们完成新项目设置的教程是非常有价值的。 通常情况下，编写教程的最佳时机是你第一次加入一个团队的时候。 技术文档得益于三种不同类型的review，每种审查都强调不同的方面： 专业的视角来保证准确性：一般由团队里比较资深的人负责，他们关注的核心点是文档写的对不对，专不专业。 06 文档写作的哲学 下面的部分更多地是关于技术写作最佳实践的论述。
3.5K20发布于 2021-09-18 - 来自专栏腾讯技术工程官方号的专栏
走进AI时代的文档识别技术 之文档重建
随着图像分析技术不断发展，我们可以将各类非同源文档通过移动终端转成图片，然后通过相关技术重建出可以直接编辑的电子文档，具体流程如下图所示。 ? 2、技术方案 2.1 技术框架 方案主要由输入模块、版面分析模块、排版模块三个模块组成，如图 3 整体方案所示。 系统首先对包含文档的图像进行检测，对扭曲的文档进行校正。 最后根据阅读顺序，生成用户可以直接编辑的电子文档，如图 4文档重建关键步骤所示。 ? 图3 整体方案 ? 图4 文档重建关键步骤 输入模块主要是进行预处理操作，分为自动框选和扭曲矫正两个步骤。 图6 仿真扭曲文档 2.3 排版识别、字体识别 版面分析网络：版面分析是文档分析中的关键技术，传统的方法是通过设计人为规则判断文档各个区域元素类型。 3、总结展望 我们运用深度学习针对拍照图片中文档的格式进行学习识别后，采用实体抽取技术实现了一键提取图片中文档的表格、图片、公式、段落样式、文字样式、排版等格式，并将包含文字、段落、排版的内容自动插入到电子文档中
7.2K64发布于 2019-06-20 应用潜在语义分析技术将文档进行3D可视化
） 的 3D 展示功能来对一个文档集合进行了可视化，这些文档是根据 AAAI 2014（一个人工智能会议）所接受的论文列表获取的。 ）将文档集合投影到三维潜在空间（3D Latent Space）中。 背景知识 详情请参阅我之前的 CodeProject 文章，以了解关于向量空间模型技术的简单知识。 然后对文档位置进行归一化以将其可视化。 使用本文的可视化技术我们可以看到，这些论文通常遵循着相当一致的模式，论文的三个主要峰值主题是 博弈论，人工智能与人类 以及 计划与执行，我们还能发现在所收集到的论文中，有大量的论文主要描述了一些具体的机器学习技术
1.2K91发布于 2018-01-29
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号