- 综合排序
- 最热优先
- 最新优先
- 来自专栏机械之心
技术文档规范
# 技术文档规范 文档采用 Markdown 语法书写。 例句：早上 8:00 # 5.9. 省略号 省略号 …… 表示语句未完、或者语气的不连续。它占两个汉字空间、包含六个省略点，不要使用 。。。 或 ... 等非标准形式。 目录结构 技术手册目录结构是一部完整的书，建议采用下面的结构。 文件名 文档的文件名不得含有空格。 文件名必须使用半角字符，不得使用全角字符。这也意味着，中文不能用于文件名。 Emoji 在 markdown 文档中，普遍会使用 emoji，帮助理解内容。但是，如果滥用 emoji，可能会适得其反。
1.6K40编辑于 2023-04-07 - 来自专栏后端码事
Kafka 技术文档
Kafka 技术文档 Kafka创建背景 Kafka是一个消息系统，原本开发自LinkedIn，用作LinkedIn的活动流（Activity Stream）和运营数据处理管道（Pipeline）的基础 （本文所用集群共8个节点，此处topic1和topic2 replication-factor均为1），如下图所示。 ? 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，高级消息队列协议，是面向消息中间件设计的应用层协议的一个开放标准。 安装Erlang. 6 4.1.3 安装RabbitMQ.. 7 4.2 RabbitMQ服务... 7 4.3 RabbitMQ页面监控系统... 7 5 使用客户端程序发送与接收消息... 8 5.1 Hello World. 8 5.2工作队列... 11 5.2.1 初级版本... 11 5.2.2 消息应答（message acknowledgments）... 14 5.2.3 消息持久化 info_log :b6a84b6a-353e-4e88-8c23-c791d93b44be' 可以看到我们实现了开头所描述的特性，接收者可以自定义自己感兴趣类型的日志。 5.使用rabbitmq管理端可以看到集群镜像模式中对列状态 8.
3K11发布于 2020-09-11 - 来自专栏杨建荣的学习笔记
关于技术文档
关于写技术文档，我觉得是很多做技术的同学头疼的，因为写起来确实有很多注意的细节，很花时间和精力，而反过来说，做技术的同学更头疼的是，工作中竟然没有文档说明，没有了文档那么就是个人主义了，所以文档的事情对很多人来说是一种比较纠结的情况 操作型文档，里面会有很多的技术细节 流程型文档，这种文档的主要是做一些铺垫和补充，比如有些内容简介，制度规约之类的。 而工作中，你的工作成果和技术积累，其实就是通过文档的积累整理出来的。我举三个例子。 首先第一个是文档库的事情。 文档库是很多公司都在使用的技术手段，如果我们要重新设计一个文档库，就会把他规划的很细很全，但是实际去写文档的时候，会发现事情比预想的要难一些，因为从业务和技术两个维度，技术上都可以实现，但是具体去操作的时候就有很大的差别 所以我们准备对已有的技术分享做一层沉淀，通过一些内容上的调整和梳理行程一个较为系统的文档，如果新员工来了之后，就会少走一些弯路。这个时候这个文档的重要性就体现出来了。 第三个是工作成果文档的事情。
921101发布于 2018-04-17 - 来自专栏icecream小屋
gensim技术文档
（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 - 来自专栏自动化、性能测试
MongoDB（8）- 文档删除操作
删除方法 db.collection.deleteOne() 删除单条文档 db.collection.deleteMany() 删除多条文档 db.collection.remove() 删除单条或多条文档 ，传递一个空文档 ({}) 就行 justOne：可选项，true，删除第一个满足删除条件的文档，默认 false，删除所有满足条件的文档 writeConcern：可选项，设置抛出异常的级别（比较复杂 只删除集合中第一条文档 删除指定条件的文档 db.inventory.deleteMany({ status : "A" }) ? status 为 “A” 的文档有两条，但只会删除匹配到的第一条 条件删除 删除 qty 字段值大于 50 的文档 db.inventory.remove( { qty: { $gt: 50 } } 删除操作的重点 删除文档不会删除索引 所有操作在单个文档级别上都是原子性的 以下方法也可以从集合中删除文档 db.collection.findOneAndDelete() db.collection.findAndModify
98510发布于 2021-06-09 【技术文档：技术传播的灯塔】
在技术的浩瀚海洋中，一份优秀的技术文档宛如精准的航海图，指引着航行者穿越波涛汹涌的未知领域。它是知识传承的载体，是团队协作的桥梁，更是产品成功的幕后英雄。然而，打造这样一份出色的技术文档并非易事。 一、技术文档的重要性技术文档是产品开发和维护过程中不可或缺的一部分。它不仅为开发者提供了详细的技术参考，也为新成员的快速上手提供了便利。一个清晰、准确的技术文档可以减少误解和错误，提高团队的工作效率。 适时更新：技术是不断发展的，技术文档也需要定期更新，以反映最新的技术变化和产品更新。 四、创新方法在技术文档的编写过程中，也可以采用一些创新的方法来提高文档的质量和可读性：交互式文档：利用现代技术，如 HTML5 和 JavaScript，创建交互式的技术文档，提供动态的示例和模拟。 社区参与：鼓励用户和开发者参与文档的编写和改进，通过社区的力量来丰富和完善文档内容。图片五、结语技术文档是技术传播的灯塔，它不仅照亮了技术实施的道路，也连接了知识的传承和团队的协作。
37800编辑于 2024-11-28- 来自专栏GopherCoder
技术文档如何编写？
关于文档编写的几个思维 近期重新组织了好几篇技术文档，把其中的一些感悟提炼出来。 按照现有文档完成后的文档输出如何组织？ 0. 程序员如何看待文档？ 程序员一定会是接触各种各样的技术文档，文档写的好与不好，大致都能区分出来。 但是对于自己写的文档却可以容忍 “丑陋” 、“难以理解”等...... 对技术、代码可以修改、修改、再修改，优化、优化、再优化...... 比如个人最崇拜的世界 Python 技术排名第五的作者： kennethreitz，他的开源作品：requests 再比如：开源 web 框架 Django 这两个项目的文档堪称是教科书式文档示例。 pic_2.png 这里有一篇中文技术文档写作规范参考：阮一峰：中文技术文档写作规范 标题： 我只谈论一点：标题原则上存在六级，即一级、二级、三级、四级、五级和六级标题。
8.1K61发布于 2018-06-06 - 来自专栏北京马哥教育
如何阅读技术文档
答：“去看文档” “Django的文档都是英文，我看不下去，怎么办” 答：“bla bla bla…. 关于英文的重要性” “Django的文档那么多，我是不是都得看完才行？” 后来随着对Django使用的越来越多，发现翻译的东西虽然能让你快速了解Django的一些东西，但是很多细节的地方还是需要去看英文文档才能明白，究其原因主要有两个：一是文档更新慢，二是文档是有志愿者参与翻译的 再之后，每每遇到问题请教同事或者在网上查得时候总能得到这样的反馈——你看过这部分的文档吗？！先去看看文档再来讨论。 于是乎，在这样不断的被鄙视过程中不断的熟悉了Django的官方文档，对于Django的问题也终于有了正确的认识——那就是，有问题就去看文档;出错了，一定是你文档看的不仔细。 除了在这样被鄙视的的状态下去看文档的，自己也尝试过去挨篇读文档，唯一的收获就是大概知道有哪些东西了，附带的收获就是对文档这东西不那么陌生了。
2.4K90发布于 2018-05-03 - 来自专栏混说Linux
搞技术，如何写好技术文档？
很多技术人自己非常轻视技术文档的书写，然而又时常抱怨文档不完善、质量差、更新不及时… 01 文档的重要性 高质量的文档对于一个组织或团队来说有非常多的益处，比如让代码和API更容易理解、错误更少； 关于文档的重要性，每个技术人或多或少都知道一些，但很多人还是没有写文档的习惯，为什么？ 1.像管理代码一样管理文档 对于如何写出好代码，整个技术圈已经有好多经验的总结了，比如书籍《重构》《代码简洁之道》…… 针对各种编程语言，也有相关的规范，比如国外的Google C++规范，国内的阿里Java 落地页的技术难度不高，但要求内容的有效性、完整性和分类清晰。 4.文档Review 在一个组织内，光靠个人去维护文档是不行的，必须得借助群体的智慧。 技术文档也算是文章的一种，所以一般也都会有这三部分，每个部分有其自己的作用，比如第一部分阐述问题，中间部分介绍具体的解决方案，第三部分总结要点。
77030编辑于 2022-11-18 - 来自专栏SAP最佳业务实践
SAP最佳业务实践:ETO–项目装配(240)-8给作业分配技术文档
image.png CJ20N给作业分配技术文档 为帮助雇员操作，可以将保存在文档管理系统中的文档分配给WBS元素和作业。在这个操作中，会将一份技术图纸分配给一个作业。 角色项目经理 1. KPR 文档 YD_ETO_DRW_01 ? 5. 选择 回车 确认输入 。 6. 标记该行并选择 显示原件 。如果有弹出对话框。选择 回车 确认。 7. 关闭文档 。 已将技术文档分配给作业 。
975100发布于 2018-03-27 - 来自专栏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 - 来自专栏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.参考文档 参考文档是工程师最常编写的文档类型;事实上，他们经常需要每天写一些参考文档。 概念性文档处理可能是API的库概述、描述服务器中数据生命周期的文档等。概念性文档是用来扩充而不是替换参考文档集的。 技术文档得益于三种不同类型的review，每种审查都强调不同的方面： 专业的视角来保证准确性：一般由团队里比较资深的人负责，他们关注的核心点是文档写的对不对，专不专业。 06 文档写作的哲学 下面的部分更多地是关于技术写作最佳实践的论述。
3.5K20发布于 2021-09-18 - 来自专栏腾讯技术工程官方号的专栏
走进AI时代的文档识别技术 之文档重建
随着图像分析技术不断发展，我们可以将各类非同源文档通过移动终端转成图片，然后通过相关技术重建出可以直接编辑的电子文档，具体流程如下图所示。 ? 2、技术方案 2.1 技术框架 方案主要由输入模块、版面分析模块、排版模块三个模块组成，如图 3 整体方案所示。 系统首先对包含文档的图像进行检测，对扭曲的文档进行校正。 图6 仿真扭曲文档 2.3 排版识别、字体识别 版面分析网络：版面分析是文档分析中的关键技术，传统的方法是通过设计人为规则判断文档各个区域元素类型。 图8 版面识别效果 字体识别网络：日常文档图片往往存在各种特色字体，比如粗体、下划线或者楷书等等。为了更好地还原文档的真实内容，这里我们引入字体识别模块支持特殊字体的识别。 Text Detector [7]Encoder-Decoder with Atrous Separable Convolution for Semantic Image Segmentation [8]
7.2K64发布于 2019-06-20 - 来自专栏飞雪无情的博客
android技术文档翻译--ant任务
以下内容由http://www.flysnow.org(飞雪无情)提供翻译 原文地址 http://tools.android.com/tech-docs/ant-tasks 更多翻译的Android技术文档请参考
64420发布于 2018-08-28 - 来自专栏OpenSCA
技术文档 | OpenSCA技术原理之composer依赖解析
开发者受到Node.js的npm及Ruby的bundler启发，composer设计上与两者有诸多相似。
2K60编辑于 2023-02-20 - 来自专栏肉眼品世界
再谈如何写好技术文档？
8 引号 “”、‘’ 一般用于标记特殊名词、专用名词、短语，或需要重点突出的名词或短语。 在技术型文档编写过程中，应该尽量少使用被动语句。 可抽象也可具体 技术型文档中的插图不一定都得是流程图、架构图、或者结构设计图这种非常具体的技术相关图片，还可以是抽象的、能形象表达文档主题的图片。 — 8 — 统一样式和风格 文档的样式和风格其实跟我们写代码一样，写代码要遵守统一的代码风格（变量命名、换行规则等等），写文档也应该遵守统一的文档风格。 对于另外一些“非主流”类型的技术型文档，比如对某个线上问题的分析报告、技术/原型调研类文档，这些文档一般规模比较小、也没什么参考标准，全靠作者自己去组织。
75620编辑于 2022-04-19 js甘特图插件(MZGantt)技术文档
//拖动杆dragHandlerBackColor:'#D8D8D8',//拖动杆背景色//lineExpandLen:0,//依赖线伸出量参数dependLineColor:'#228B22',//连接线颜色 Array前置节点，多个前置节点时，使用逗号分开6.parentId//（可选）String父节点编号(当前行是最顶层节点时，该值须设置为空"")7.isMS//（可选）Number(0或1)是否里程碑8. 1000,"iconColsVal":[],"name":"单位A施工期间","rsltStart":"","rsltEnd":"","rsltDur":1,"planBarColor":"#C0EBE8"
26200编辑于 2026-01-13
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号