- 综合排序
- 最热优先
- 最新优先
- 来自专栏机械之心
技术文档规范
# 技术文档规范 文档采用 Markdown 语法书写。 # 2. 文本 # 2.1. 字间距 全角中文字符与半角英文字符之间，应有一个半角空格。 反例：本文介绍如何快速启动Windows系统。 正例：本文介绍如何快速启动 Windows 系统。 目录结构 技术手册目录结构是一部完整的书，建议采用下面的结构。 文件名 文档的文件名不得含有空格。 文件名必须使用半角字符，不得使用全角字符。这也意味着，中文不能用于文件名。 Emoji 在 markdown 文档中，普遍会使用 emoji，帮助理解内容。但是，如果滥用 emoji，可能会适得其反。
1.6K40编辑于 2023-04-07 - 来自专栏后端码事
Kafka 技术文档
Kafka 技术文档 Kafka创建背景 Kafka是一个消息系统，原本开发自LinkedIn，用作LinkedIn的活动流（Activity Stream）和运营数据处理管道（Pipeline）的基础 properties: broker.id=2 port=9094 log.dir=/tmp/kafka-logs-2 broker.id属性别重样。 Isr: 1,2,0 第一行给出了分区的汇总信息。 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，高级消息队列协议，是面向消息中间件设计的应用层协议的一个开放标准。 （2）镜像模式：把需要的队列做成镜像队列。 AMQP模型 image.png 2. [x] Sent routingKey = auth.info ,msg = 3273f21f-6e6e-42f2-83df-1f2fafa7a19a. （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_1.png 2. 编写文档的整体流程有哪些？ pic_2.png 这里有一篇中文技术文档写作规范参考：阮一峰：中文技术文档写作规范 标题： 我只谈论一点：标题原则上存在六级，即一级、二级、三级、四级、五级和六级标题。 综上：编写文档的两个思维是： 流程化：1. 先有什么 2. 后有什么 3. 最后结果 精细化：逻辑表达、内容组织、排版 ? pic_3.png
8.1K61发布于 2018-06-06 - 来自专栏北京马哥教育
如何阅读技术文档
答：“去看文档” “Django的文档都是英文，我看不下去，怎么办” 答：“bla bla bla…. 关于英文的重要性” “Django的文档那么多，我是不是都得看完才行？” 后来随着对Django使用的越来越多，发现翻译的东西虽然能让你快速了解Django的一些东西，但是很多细节的地方还是需要去看英文文档才能明白，究其原因主要有两个：一是文档更新慢，二是文档是有志愿者参与翻译的 再之后，每每遇到问题请教同事或者在网上查得时候总能得到这样的反馈——你看过这部分的文档吗？！先去看看文档再来讨论。 于是乎，在这样不断的被鄙视过程中不断的熟悉了Django的官方文档，对于Django的问题也终于有了正确的认识——那就是，有问题就去看文档;出错了，一定是你文档看的不仔细。 除了在这样被鄙视的的状态下去看文档的，自己也尝试过去挨篇读文档，唯一的收获就是大概知道有哪些东西了，附带的收获就是对文档这东西不那么陌生了。
2.4K90发布于 2018-05-03 - 来自专栏混说Linux
搞技术，如何写好技术文档？
很多技术人自己非常轻视技术文档的书写，然而又时常抱怨文档不完善、质量差、更新不及时… 01 文档的重要性 高质量的文档对于一个组织或团队来说有非常多的益处，比如让代码和API更容易理解、错误更少； 关于文档的重要性，每个技术人或多或少都知道一些，但很多人还是没有写文档的习惯，为什么？ 比如： 有统一的规范 有版本控制 有明确的责任人维护 有变更Review机制 有问题的反馈和更新机制 定期更新 有衡量的指标(比如准确性，时效性) 2.明确你的读者是谁 写文档有一个很常见的错误，那就是很多人文档都是写给自己看的 落地页的技术难度不高，但要求内容的有效性、完整性和分类清晰。 4.文档Review 在一个组织内，光靠个人去维护文档是不行的，必须得借助群体的智慧。 WHY：为什么要写这篇文档， 你期望读者读完后从文档中获得什么！ 2.三段式写作 写文章一般都会有三个部分，专业写作者也讲究凤头、猪肚、豹尾，这三个词概括出了好文章三部分应有的特点。
77030编辑于 2022-11-18 - 来自专栏编程心路
Github学习文档-2
牵手GitHub.jpg 目录 1.GitHub 和 Git 的前世今缘 2.Git 的下载安装 2.1Git 下载 2.2Git 安装 3.Git 的初始配置 3.1查看安装的 Git 的版本 2 Git 的下载安装 ---- 以 windows 环境下安装为例，Linux 和 Mac 系统请自行查找 Git 安装资料 2.1 Git 下载 Git的官方下载地址 ? 下载Git2.png 如果你的下载速度较慢，也可以选择去软件应用中心下载，这里也推荐一个百度软件下载中心，但里面的软件不一定是最新的，还是建议在官网上下载的。
79330发布于 2018-08-30 - 来自专栏史上最简单的Spring Cloud教程
Docker官方文档翻译2
article/details/80158062 本文出自方志朋的博客 个人博客纯净版：https://www.fangzhipeng.com/docker/2018/09/11/dokcer-trans2. 应用程序部分 创建2个文件，requirements.txt和app.py，并且将它们放到和Dockerfile放进同一个文件夹中。这就完成了我们的应用，你可以发现用创建应用很简单。 import os import socket # Connect to Redis redis = Redis(host="redis", db=0, socket_connect_timeout=2, 为该上下文提供存储库并标记有意义的名称，例如get-started：part2。 这将图像放入启动存储库并将其标记为part2。 现在，把它放在一起来标记图像。 $ docker run -p 4000:80 john/get-started:part2 Unable to find image 'john/get-started:part2' locally
52220编辑于 2022-05-07 - 来自专栏AI SPPECH
4：Youtu-Parsing 文档解析模型：2B参数的文档智能解析技术深度解析
2. 2B参数设计平衡了性能和硬件需求 简化系统设计：一体化框架减少了系统复杂度 拓展应用场景：强大的结构化识别能力打开了新的应用可能性 促进技术普及：开源发布降低了文档智能处理技术的使用门槛 5.2 潜在风险 未来趋势与前瞻预测 6.1 技术发展趋势 基于Youtu-Parsing的技术创新，未来文档解析技术可能朝着以下方向发展： 更高效的视觉编码：进一步优化视觉编码效率，减少计算开销 更强的结构化理解：提升对复杂文档结构的理解能力 行业生态影响 Youtu-Parsing的成功将对行业生态产生以下影响： 技术标准化：推动文档解析技术的标准化 开源协作：促进文档智能处理领域的开源协作 创业机会：催生基于文档解析技术的新创业方向 跨领域融合 参考链接： 主要来源：Youtu-Parsing官方页 - Youtu-Parsing模型详情 主要来源：腾讯优图实验室官网 - 实验室技术介绍 辅助：文档解析技术研究综述 - 技术综述 辅助：视觉语言模型在文档理解中的应用
26410编辑于 2026-02-04 - 来自专栏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阅码场
如何写好技术文档？
软件工程师经常需要编写几种主要类型的文档： 参考文档，包括注释 设计文档； 教程； 概念性文档； 1.参考文档 参考文档是工程师最常编写的文档类型;事实上，他们经常需要每天写一些参考文档。 2.设计文档 大多数公司在项目开始之前都需要有设计文档。软件工程师通常使用团队批准的特定设计文档模板来编写建议的设计文档。然后还需要在特定的团队会议上讨论或评论设计的细节。 技术文档得益于三种不同类型的review，每种审查都强调不同的方面： 专业的视角来保证准确性：一般由团队里比较资深的人负责，他们关注的核心点是文档写的对不对，专不专业。 06 文档写作的哲学 下面的部分更多地是关于技术写作最佳实践的论述。 虽然很多工程师都讨厌冗余 极力追求简洁，但写文档和写代码不同，适当的冗余反而可以帮助读者理解。 2.好文档必备的属性 好的文档通常有三个方面:完整性、准确性和清晰度。
3.5K20发布于 2021-09-18 - 来自专栏腾讯技术工程官方号的专栏
走进AI时代的文档识别技术 之文档重建
随着图像分析技术不断发展，我们可以将各类非同源文档通过移动终端转成图片，然后通过相关技术重建出可以直接编辑的电子文档，具体流程如下图所示。 ? 图2 传统OCR文档重建 可以发现与传统的OCR识别方案不同，我们需要识别出图片中的表格、图片、公式、段落样式、文字样式、排版等内容，并可以在保证内容不丢失的情况下直接插入到文档中，将纸质文档一键转换成可直接编辑的电子文档 （2）版面分析得到段落、图片、表格等结构化信息后，再进行OCR识别和表格恢复。 （3）生成用户可以直接编辑的格式。 2、技术方案 2.1 技术框架 方案主要由输入模块、版面分析模块、排版模块三个模块组成，如图 3 整体方案所示。 系统首先对包含文档的图像进行检测，对扭曲的文档进行校正。 图6 仿真扭曲文档 2.3 排版识别、字体识别 版面分析网络：版面分析是文档分析中的关键技术，传统的方法是通过设计人为规则判断文档各个区域元素类型。
7.2K64发布于 2019-06-20 - 来自专栏机器人课程与技术
ROS 2 Humble Hawksbill 官方文档
全部文档：docs.ros.org 5年长支持版本ROS2 humble： docs.ros.org/en/humble ROS 2 文档 机器人操作系统 (ROS) 是一组用于构建机器人应用程序的软件库和工具 ROS 2 项目的目标是适应这些变化，利用 ROS 1 的优点并改进不足之处。 处理这些教程的最佳方法是第一次按顺序浏览它们，因为它们是相互构建的，并不意味着是全面的文档。 2 操作指南 docs.ros.org/en/humble/How-To-Guides.html 操作指南为有关 ROS 2 关键方面的“操作方法”问题提供直接和模块化的答案。 操作指南适用于已经对 ROS 2 有所了解并且只想了解如何实现特定内容的用户。他们不会通过提供背景信息或教授概念如何与更大的 ROS 2 生态系统联系来深入探讨。
1.1K10编辑于 2022-05-27 - 来自专栏python3
Python 官方文档解读(2)：thr
例如下面这个爬虫程序： import Queue import threading import urllib2 # 被每个线程调用 def get_url(q, url): q.put(urllib2
1.1K10发布于 2020-01-17 - 来自专栏飞雪无情的博客
android技术文档翻译--ant任务
以下内容由http://www.flysnow.org(飞雪无情)提供翻译 原文地址 http://tools.android.com/tech-docs/ant-tasks 更多翻译的Android技术文档请参考
64420发布于 2018-08-28
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号